Retrieve API keys

Request

Retrieve a list of API keys.
Security
SecretApiKey or JWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/api-keys?filter=string&sort=string&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of API keys retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
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)
Permissions for this API key. A request is authorized only when these permissions include the permission for the operation, and the associated user has that permission. If these permissions include `*`, each operation is limited to the permissions of the associated user. If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized. If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`. For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
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"
]
lastUsedTimestring or null, (date-time)read-only

Date and time when the API key last authenticated a request. This value is updated at most once every 5 minutes. This value is null if the API key has no recorded use.

lastUsedIpstring or null, (ip)read-only

IP address of the request that last updated lastUsedTime. This value is null if the API key has no recorded use.

expirationTimestring or null, (date-time)

Date and time when the API key expires. From this time, a request that uses the API key gets a 401 response. If this value is not in the future, a validation error is returned. To remove the expiration, set this property to null. If an update request omits this property, the expiration time is not changed. This value is null if the API key does not expire.

apiUserstringread-only
API user name.
secretKeystringread-only

Value of the API secret key. For a secret key, the full value is returned only in the response to the request that creates the key. Other responses return a masked value that keeps only the prefix and the apiUser value. For a publishable key, every response returns the full value.

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.
_linksArray of objects(SelfLink)read-only
Related links.
]
Response
[
  {
    "id": "api_key_0YV7JQMY6ED2FBE58BMFHBWBZH",
    "description": "string",
    "type": "secret",
    "acl": [ … ],
    "allowedIps": [ … ],
    "lastUsedTime": "2019-08-24T14:15:22Z",
    "lastUsedIp": "string",
    "expirationTime": "2019-08-24T14:15:22Z",
    "apiUser": "string",
    "secretKey": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]