POST /api-keys
Create an API key.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
ID of the API key. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
apiUser |
String | No |
API user name. |
description |
String | Yes |
API key description. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
type |
String | No |
Type of API key. Valid values:
Default value: "secret" |
allowedIps[] |
Array | No |
List of IP addresses that are permitted access.
Private subnets are prohibited.
To remove restrictions, set this value to |
acl[] |
Array | No |
Specify access control list here if creating a restricted API key. Send all matching permission with an empty scope to allow all permissions. |
acl[].scope |
Object | Yes |
Scope of the API key. |
acl[].scope.customFieldName[] |
Array | No |
Array of custom field names. |
acl[].scope.productId[] |
Array | No |
Array of product IDs. |
acl[].scope.planId[] |
Array | No |
Array of plan IDs. |
acl[].scope.organizationId[] |
Array | No |
Array of account IDs. |
acl[].permissions[] |
Array | Yes |
If you are creating a restricted API key, use this field to specify individual permissions.
Use the wildcard character |
secretKey |
String | No |
Value of the API secret key. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.