API Keys
Get all API Keys [GET]
get
/api-key
Request
GET
/api-keyParameters
pageintegeroptional
Type: query
Description:
Default Value: 1
sizeintegeroptional
Type: query
Description:
Default Value: 10
searchstringoptional
Type: query
Description:
sortstringoptional
Type: query
Description:
subAccountIdintegeroptional
Type: query
Description:
permissionTypestringoptional
Type: query
Description:
Parameters
GET
/api-key?page=1&size=10&search=string&sort=string&subAccountId=1&permissionType=stringResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties apiKeysarray of object Object Properties createdAtinteger idinteger keystring namestring permissionTypestring subAccountIdinteger subAccountNamestring countinteger | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Create API key [POST]
post
/api-key
Request
POST
/api-keyRequest Body
API key data
allowedIpstringoptional
Description:
Example: 123.123.123.123,
namestringoptional
Description:
permissionIdsarray of integeroptional
Description:
Request Body
{
"allowedIp": "123.123.123.123,",
"name": "string",
"permissionIds": [
1
]
}
Response
| Code | Description | Type |
|---|---|---|
| 201 | object | |
Object Properties allowedIpstring companyIdinteger companyNamestring createdAtinteger idinteger keystring namestring permissionTypestring permissionsarray of object Object Properties detailstring idinteger namestring subAccountIdinteger subAccountNamestring | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
201
400
401
500
Get Detail API Key [GET]
get
/api-key/{id}
Request
GET
/api-key/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
GET
/api-key/1Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties allowedIpstring companyIdinteger companyNamestring createdAtinteger idinteger keystring namestring permissionTypestring permissionsarray of object Object Properties detailstring idinteger namestring subAccountIdinteger subAccountNamestring | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Update API key [PUT]
put
/api-key/{id}
Request
PUT
/api-key/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
PUT
/api-key/1Request Body
API key data
allowedIpstringoptional
namestringoptional
permissionIdsarray of integeroptional
permissionTypestringoptional
Request Body
{
"allowedIp": "string",
"name": "string",
"permissionIds": [
1
],
"permissionType": "string"
}
Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties allowedIpstring companyIdinteger companyNamestring createdAtinteger idinteger keystring namestring permissionTypestring permissionsarray of object Object Properties detailstring idinteger namestring subAccountIdinteger subAccountNamestring | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Delete API key [DELETE]
delete
/api-key/{id}
Request
DELETE
/api-key/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
DELETE
/api-key/1Response
| Code | Description | Type |
|---|---|---|
| 200 | boolean | |
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500