Nexus
Nexus APIs
POST
/v1/api-keys
Creates a new API key.
Request body
Request payload
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"expiresAt": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
description
|
string
|
nullable | Description | — |
expiresAt
|
string (date-time)
|
nullable | Expiration date (optional, defaults to 1 year from creation if not provided) | — |
id
|
string
|
nullable | Id | — |
permissions
|
string
|
nullable | Permissions | — |
roleId
|
string
|
nullable | Role ID (optional) | — |
secret
|
string
|
nullable | Secret (auto-generated if not provided) | — |
Responses
201
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
Example
{
"id": "string",
"roleId": "string",
"secret": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"expiresAt": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
expiresAt
|
string (date-time)
|
— | — | — |
id
|
string
|
nullable | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | — | — |
roleId
|
string
|
nullable | — | — |
secret
|
string
|
nullable | — | — |
userId
|
string
|
nullable | — | — |
400
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic