younifyd
Menu

List Application Keys

List Application Keys

GET/v2/application-keys

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Application Keys action (under Application Keys).
  3. Fill in the fields below, then reference the result from later steps as {{listApplicationKeys.response.data}}.

Request

Query parameters

page[offset]integer (int64)

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](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[limit]integer (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](/docs/api/settings/settings-introduction#page-length) store setting is used.

Response

Returns 200 with an object. Read it in later steps with {{listApplicationKeys.response.data.<field>}}.

dataarray<object>
idstring (uuid)

The unique identifier for the Application Key.

typestring

Specifies the type of the resource object, always `application_key` for Application Keys.

namestring

Specifies the name of this Application Key.

reserved_rate_limitinteger

Indicates the reserved rate limit for an application key. For more information, see [Application Keys Overview](/docs/api/application-keys/application-keys-introduction).

client_idstring

Represents the unique `client_id`.

metaobject1 fields
metaobject
resultsobject1 fields
pageobject4 fields
total_reserved_rate_limitinteger

Sum of rate limit reserved for all application keys.

linksobject
currentstring | null
firststring | null
laststring | null
nextstring | null
prevstring | null
json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "name": "string",
      "reserved_rate_limit": 0,
      "client_id": "Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA",
      "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"
        }
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "total_reserved_rate_limit": 100
  },
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.