Sub Accounts
Get Sub Account [GET]
get
/sub-account
Request
GET
/sub-accountParameters
pageintegeroptional
Type: query
Description:
Default Value: 1
sizeintegeroptional
Type: query
Description:
Default Value: 10
Parameters
GET
/sub-account?page=1&size=10Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties countinteger subAccountsarray of object Object Properties created_atstring idinteger namestring statusstring | ||
| 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 Sub Account [POST]
post
/sub-account
Request
POST
/sub-accountRequest Body
Create Sub Account Form
allowedIpsstringoptional
Example: 123.123.123.123,
apiKeyNamestringoptional
createApiKeybooleanoptional
ipPoolIdintegeroptional
namestringoptional
permissionIdsarray of integeroptional
permissionTypestringoptional
statusstringoptional
Request Body
{
"allowedIps": "123.123.123.123,",
"apiKeyName": "string",
"createApiKey": true,
"ipPoolId": 1,
"name": "string",
"permissionIds": [
1
],
"permissionType": "string",
"status": "string"
}
Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties apiKeysarray of object Object Properties createdAtinteger idinteger keystring namestring permissionTypestring subAccountIdinteger subAccountNamestring companyIdinteger createdAtinteger domainsarray of object Object Properties createdAtinteger domainstring idinteger updatedAtinteger idinteger ipPoolIdinteger ipPoolNamestring statusstring 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
Get Sub Account [GET]
get
/sub-account/{id}
Request
GET
/sub-account/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
GET
/sub-account/1Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties apiKeysarray of object Object Properties createdAtinteger idinteger keystring namestring permissionTypestring subAccountIdinteger subAccountNamestring companyIdinteger createdAtinteger domainsarray of object Object Properties createdAtinteger domainstring idinteger updatedAtinteger idinteger ipPoolIdinteger ipPoolNamestring statusstring 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 Sub Account [PUT]
put
/sub-account/{id}
Request
PUT
/sub-account/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
PUT
/sub-account/1Request Body
Update Sub Account Form
ipPoolIdintegeroptional
namestringoptional
statusstringoptional
Request Body
{
"ipPoolId": 1,
"name": "string",
"status": "string"
}
Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties apiKeysarray of object Object Properties createdAtinteger idinteger keystring namestring permissionTypestring subAccountIdinteger subAccountNamestring companyIdinteger createdAtinteger domainsarray of object Object Properties createdAtinteger domainstring idinteger updatedAtinteger idinteger ipPoolIdinteger ipPoolNamestring statusstring 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 Sub Account [DELETE]
delete
/sub-account/{id}
Request
DELETE
/sub-account/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
DELETE
/sub-account/1Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 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