Create an Application Key

POST 
/v2/application-keys

Create an Application Key

Request

application/json

Body

required

data ApplicationKeyrequired

name stringrequired

Possible values: non-empty and <= 255 characters

Specifies the name of the application key.

reserved_rate_limit integer

Indicates the reserved rate limit for an application key. For more information, see Application Keys Overview.

type stringrequired

Represents the type of object being returned. Always application_key.

Responses

201

Created

application/json

Schema

Schema

data object

id uuid

Specifies the unique id of the application key.

name stringrequired

Specifies the name of the application key.

type stringrequired

Represents the type of object being returned. Always application_key.

client_id string

Represents the unique client_id.

client_secret string

Represents the unique client_secret.

reserved_rate_limit integer

Indicates the reserved rate limit for an application key. For more information, see Application Keys Overview.

meta object

timestamps object

created_at string

Specifies the creation date of the key.

updated_at string

Specifies the last updated date of the key.

last_used_at string

Specifies the approximate last used date of the key. A null value indicates that the key has not been used.

links object

self string

Represents a link to the specific resource.

Example (from schema)

{
  "data": {
    "id": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0",
    "name": "App Key",
    "type": "string",
    "client_id": "Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA",
    "client_secret": "jN8qLHneOn8C1rv0r3J3XZK1cRiZG3rajcLi9X1cZZ",
    "reserved_rate_limit": 10,
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z",
        "last_used_at": "2017-01-10T11:41:19.244Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/application-keys/0c45e4ec-26e0-4043-86e4-c15b9cf985a0"
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "The field 'name' is required."
    }
  ]
}

409

Conflict

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

exceeds-limit

Requested limit exceeds maximum

{
  "errors": [
    {
      "detail": "requested reserved rate limit will exceed the maximum",
      "status": "409",
      "title": "Conflict"
    }
  ]
}

default

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...