HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. apiKey

Create new API key

post
http://127.0.0.1:8080/apiKey

Creates a new API key for authentication. Returns the generated key value only once upon successful creation. Either permission or rbacRoles must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

API key configuration. Name is required and must be unique. Either permission or rbacRoles must be set.

Request body for creating a new API key. Either permission or rbacRoles must be provided.

string
required

Unique identifier name for the API key. Must not already exist.

string

Human-readable description of the API key's purpose.

boolean
Defaults to true

Whether the API key should be active upon creation. Set to false to create a disabled key.

int64
Defaults to 0

UNIX timestamp (seconds) when the key expires. Set to 0 for no expiration.

string
enum

Access level for the API key. Required if rbacRoles is not set. Use empty string when using rbacRoles.

Allowed:
string

Comma-separated RBAC role names. Required if permission is empty. Overrides basic permission when set.

string

Name of an appliance access group to restrict which appliances this key can manage.

ipList
array of strings

IP addresses or CIDR subnets allowed to use this key. Empty array allows all IPs.

ipList
Responses

401

Unauthorized. Authentication required or invalid credentials.

403

Forbidden. User does not have net_read_write permission required to create API keys.

409

Conflict. An API key with the specified name already exists. Choose a unique name.

Updated about 13 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 13 hours ago

Did this page help you?