List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.
Creates an API key for the authenticated user. The key is not assigned to another user. If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized. For more information, see Ownership of an API key.
[ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ]
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.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/api-keys
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/api-keys
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/api-keys
curl -i -X POST \
https://www.rebilly.com/_mock/catalog/all/api-keys \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"description": "string",
"type": "secret",
"acl": [
{
"scope": {
"organizationId": [
"organizationId-id-1"
]
},
"permissions": [
"PostFile",
"StorefrontGetAccount",
"StorefrontGetWebsite",
"StorefrontGetKycDocument",
"StorefrontPostKycDocument"
]
}
],
"allowedIps": [
"153.12.32.33",
"201.54.122.0/24",
"2001:0db8:abcd:0012:0000:0000:0000:ffff",
"2001:db8:abcd:12::0/64"
],
"expirationTime": "2019-08-24T14:15:22Z"
}'Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.
Number of requests still available for this rate limit. For more information, see Rate limits.
List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.
[ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ]
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.
IP address of the request that last updated lastUsedTime. This value is null if the API key has no recorded use.
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.
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.
{ "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" ], "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": [ { … } ] }