Create or update (upsert) API key with a specified ID.
Security
SecretApiKey or JWT
ApiKey resource.
Specify access control list here if creating a restricted API key. Send all matching permission with an empty scope to allow all permissions.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/api-keys/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/api-keys/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/api-keys/{id}
- SecretApiKey
- JWT
curl -i -X PUT \
'https://www.rebilly.com/_mock/catalog/all/api-keys/{id}' \
-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"
]
}'API key updated.
Specify access control list here if creating a restricted API key. Send all matching permission with an empty scope to allow all permissions.
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" ]
Date and time when the resource is created. This value is set automatically when the resource is created.
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": [ { … } ] }