Get all Application Keys

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

You can use pagination with this resource. For more information, see pagination.

Request

Query Parameters

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int64

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
iduuid
Specifies the unique id of the application key.
Example: 0c45e4ec-26e0-4043-86e4-c15b9cf985a0
namestring
Specifies the name of the application key.
Example: App Key
typestring
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
]
meta object
results objectrequired
totalinteger
Total number of results for the entire collection.
page objectrequired
limitinteger
The maximum number of records for all pages.
Example: 100
offsetinteger
The current offset by number of pages.
Example: 0
currentinteger
The current number of pages.
Example: 1
totalinteger
The total number of records for the entire collection.
Example: 1
total_reserved_rate_limitinteger
Total reserved rate limit.
links object
currenturirequired
Always the current page.
Example: /v2/application-keys?page[offset]=0&page[limit]=100
firsturirequired
Always the first page.
Example: /v2/application-keys?page[offset]=0&page[limit]=100
lasturirequired
Always null if there is only one page.
Example: /v2/application-keys?page[offset]=0&page[limit]=100
nextstring | nullrequired
Always null if there is only one page.
Example: null
prevstring | nullrequired
Always null if the user is on the first page.
Example: null

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"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "total_reserved_rate_limit": 0
  },
  "links": {
    "current": "/v2/application-keys?page[offset]=0&page[limit]=100",
    "first": "/v2/application-keys?page[offset]=0&page[limit]=100",
    "last": "/v2/application-keys?page[offset]=0&page[limit]=100",
    "next": null,
    "prev": null
  }
}

get-keys

Get Application Keys

{
  "data": [
    {
      "id": "2a0949f6-661b-4a19-b0ed-e97b41e98623",
      "name": "Storefront",
      "type": "application_key",
      "client_id": "d4fcc576f661778c29fcd7b78461da8291cc6b003d",
      "reserved_rate_limit": 50,
      "meta": {
        "timestamps": {
          "last_used_at": "2022-08-24T19:53:52.474283Z",
          "created_at": "2022-08-24T19:53:52.474283Z",
          "updated_at": "2022-08-24T19:53:52.474283Z"
        }
      }
    },
    {
      "id": "015b8b6d-36a0-4c7f-b216-3cf233f49b95",
      "name": "Search Integration",
      "type": "application_key",
      "client_id": "ada730106344ad8e62b07abe2fcef7e540014f33c2",
      "reserved_rate_limit": 0,
      "meta": {
        "timestamps": {
          "last_used_at": "2022-08-24T20:11:54.347893Z",
          "created_at": "2022-08-24T20:11:54.347893Z",
          "updated_at": "2022-08-24T20:11:54.347893Z"
        }
      }
    }
  ],
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/application-keys?page[offset]=25&page[limit]=0",
    "first": "https://useast.api.elasticpath.com/v2/application-keys?page[offset]=0&page[limit]=25",
    "last": "https://useast.api.elasticpath.com/v2/application-keys?page[offset]=0&page[limit]=25",
    "next": null,
    "prev": null
  },
  "meta": {
    "page": {
      "limit": 25,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "results": {
      "total": 2
    },
    "total_reserved_rate_limit": 50
  }
}

401

Unauthorized

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

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

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.Get, "https://useast.api.elasticpath.com/v2/application-keys");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

Parameters

page[offset] — query

page[limit] — query

ResponseClear

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