/
Retrieve API key

Retrieve API key

Request

Retrieve API key with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/api-keys/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

API key retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the API key.

Example:"api_key_0YV7JQMY6ED2FBE58BMFHBWBZH"
descriptionstringrequired

API key description.

typestring

Type of API key.

Default:"secret"
Enum:"secret""publishable"
aclArray of objects(Acl)

Specify access control list here if creating a restricted API key. Send all matching permission with an empty scope to allow all permissions.

allowedIpsArray of strings or null, (ip)(AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Example:
[
  "153.12.32.33",
  "201.54.122.0/24",
  "2001:0db8:abcd:0012:0000:0000:0000:ffff",
  "2001:db8:abcd:12::0/64"
]
apiUserstringread-only

API user name.

secretKeystringread-only

Value of the API secret key.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "api_key_0YV7JQMY6ED2FBE58BMFHBWBZH",
  "description": "string",
  "type": "secret",
  "acl": [
    { … }
  ],
  "allowedIps": [
    "153.12.32.33",
    "201.54.122.0/24",
    "2001:0db8:abcd:0012:0000:0000:0000:ffff",
    "2001:db8:abcd:12::0/64"
  ],
  "apiUser": "string",
  "secretKey": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}