Get An Application Key

Get an Application Key

GET/v2/application-keys/{application-key-id}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get An Application Key action (under Application Keys).
Fill in the fields below, then reference the result from later steps as {{getAnApplicationKey.response.data}}.

Request

Path parameters

application-key-idstring (uuid)required

The unique identifier of the Application Key.

Response

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

dataobject

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

linksobject

selfstring | 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"
      }
    }
  },
  "links": {
    "self": "string"
  }
}

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

Was this page helpful?