Skip to content

createApiKey

POST
/v1/developers/api-keys
curl --request POST \
--url https://testnet-rpc.necter.network/v1/developers/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "scopes": [ "tasks:submit" ], "project_ids": [ "example" ], "expires_at": 1 }'
Media typeapplication/json
object
name
required
string
<= 64 characters
scopes
required
Array<string>
Allowed values: tasks:submit projects:read projects:write modules:write analytics:read
project_ids

Restrict to these projects (default: all of the developer)

Array<string>
expires_at
One of:
integer

Created; secret is shown once

Media typeapplication/json
object
key_id
required
string
name
required
string
prefix
required
string
scopes
required
Array<string>
Allowed values: tasks:submit projects:read projects:write modules:write analytics:read
project_ids
Array<string>
last_used_at
One of:
integer
expires_at
One of:
integer
created_at
required
integer
secret
required
string

Example

{
"prefix": "nk_test_ab12cd34",
"scopes": [
"tasks:submit"
],
"secret": "nk_test_ab12cd34_…"
}

Authenticated but not allowed (forbidden, not_owner, not_enrolled, not_verified, scope_missing)

Media typeapplication/json
object
error
required

Stable machine code

string
message
required
string
details
object
key
additional properties
any
request_id
required
string

Example generated

{
"error": "example",
"message": "example",
"details": {},
"request_id": "example"
}