Create a project API key
Creates an API key for the project. The key is returned once, in this response, and cannot be retrieved again.
Creates an API key for the project. The key is returned once, in this response, and cannot be retrieved again.
Headers
AuthorizationRequiredBearer <SONIOX_API_KEY>Request
application/jsonRequirednameRequiredstringLabel of the API key.
permissionsRequiredarray<string>What the key may call, as resource:level. At least one; one level per resource.
Path parameters
project_idRequiredstring"uuid"Response
201
Created
idRequiredstringUnique identifier of the API key.
"uuid"keyRequiredstringThe API key. Returned only here; it cannot be retrieved again.
key_prefixRequiredstringLeading characters of the key, so keys can be told apart.
nameRequiredstringLabel of the API key.
permissionsRequiredarray<string>What the key may call, as resource:level; write includes read.
created_atRequiredstringWhen the key was created.
"date-time"created_byRequiredstringThe organization API key that created it.
created_by_key_idRequiredstringId of the organization API key that created this key.
"uuid"Errors
Created
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"key_prefix": "string",
"name": "string",
"permissions": [
"stt_rt:write"
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_key_id": "7954020d-fd00-436f-97d5-c7e64e43cdfb"
}Bad Request
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Unauthorized
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Forbidden
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Not Found
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Too Many Requests
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Internal Server Error
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}Service Unavailable
{
"status_code": 0,
"error_type": "string",
"message": "string",
"validation_errors": [
{
"error_type": "string",
"location": "string",
"message": "string"
}
],
"request_id": "string",
"more_info": "string"
}