Create an Application Key

POST 
https://useast.api.elasticpath.com/v2/application-keys

Create an Application Key

Request

application/json

Bodyrequired

data ApplicationKeyrequired

namestringrequired

Specifies the name of the application key.

Possible values: non-empty and <= 255 characters

Example: App Key

reserved_rate_limitinteger

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

Example: 10

typestringrequired

Represents the type of object being returned. Always application_key.

Responses

201

Created

application/json

Schema

Schema

data object
iduuid
Specifies the unique id of the application key.
Example: 0c45e4ec-26e0-4043-86e4-c15b9cf985a0
namestringrequired
Specifies the name of the application key.
Example: App Key
typestringrequired
Represents the type of object being returned. Always application_key.
client_idstring
Represents the unique client_id.
Example: Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA
client_secretstring
Represents the unique client_secret.
Example: jN8qLHneOn8C1rv0r3J3XZK1cRiZG3rajcLi9X1cZZ
reserved_rate_limitinteger
Indicates the reserved rate limit for an application key. For more information, see Application Keys Overview.
Example: 10
meta object
timestamps object
created_atstring
Specifies the creation date of the key.
Example: 2017-01-10T11:41:19.244Z
updated_atstring
Specifies the last updated date of the key.
Example: 2017-01-10T11:41:19.244Z
last_used_atstring
Specifies the approximate last used date of the key. A null value indicates that the key has not been used.
Example: 2017-01-10T11:41:19.244Z
links object
selfstring
Represents a link to the specific resource.
Example: https://useast.api.elasticpath.com/v2/application-keys/0c45e4ec-26e0-4043-86e4-c15b9cf985a0

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/application-keys");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"name\": \"App Key\",\n    \"reserved_rate_limit\": 10,\n    \"type\": \"string\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Body required

{
  "data": {
    "name": "App Key",
    "reserved_rate_limit": 10,
    "type": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!