Aquanode API Keys API
The API Keys API from Aquanode — 7 operation(s) for api keys.
The API Keys API from Aquanode — 7 operation(s) for api keys.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/aquanode-io:aquanode-io-api-keys-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
title: Aquanode Orchestrator API Keys API
description: API documentation for the Aquanode deployment orchestrator.
servers:
- url: /api/v1
tags:
- name: API Keys
paths:
/api-keys/teams/{teamId}:
post:
summary: Create API Key
description: Creates a new API Key for the team.
tags:
- API Keys
security:
- BearerAuth: []
parameters:
- schema:
type: string
format: uuid
required: true
name: teamId
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApiKey'
responses:
'200':
description: API Key created successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- timestamp
'400':
description: Invalid request data
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
operationId: postApiKeysTeamsByTeamId
x-operation-id-source: derived
get:
summary: List API Keys
description: Lists all API keys for the team.
tags:
- API Keys
security:
- BearerAuth: []
parameters:
- schema:
type: string
format: uuid
required: true
name: teamId
in: path
responses:
'200':
description: API Keys retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
operationId: getApiKeysTeamsByTeamId
x-operation-id-source: derived
/api-keys/teams/{teamId}/{keyId}:
delete:
summary: Revoke API Key
description: Revokes (deletes) an API Key for the team.
tags:
- API Keys
security:
- BearerAuth: []
parameters:
- schema:
type: string
format: uuid
required: true
name: teamId
in: path
- schema:
type: string
format: uuid
required: true
name: keyId
in: path
responses:
'200':
description: API Key revoked successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- timestamp
'400':
description: Invalid request data
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.356Z'
required:
- success
- error
- timestamp
operationId: deleteApiKeysTeamsByTeamIdByKeyId
x-operation-id-source: derived
/api-keys/device/start:
post:
summary: Start CLI device login
description: 'Begins the `aq login` device-grant pairing. Public (unauthenticated): returns a secret deviceCode for polling and a short userCode the user approves in the console.'
tags:
- API Keys
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartDeviceAuth'
responses:
'200':
description: Device authorization started
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.357Z'
required:
- success
- timestamp
'400':
description: Invalid request data
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.357Z'
required:
- success
- error
- timestamp
operationId: postApiKeysDeviceStart
x-operation-id-source: derived
/api-keys/device/token:
post:
summary: Poll CLI device login
description: Polls a pairing by its deviceCode. Public. Returns `{ status }` of pending | approved | denied | expired | consumed; on the first approved poll it returns the issued token exactly once.
tags:
- API Keys
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PollDeviceAuth'
responses:
'200':
description: Device authorization status
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- timestamp
'400':
description: Unknown or expired device code
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
operationId: postApiKeysDeviceToken
x-operation-id-source: derived
/api-keys/device/{userCode}:
get:
summary: Get pairing details
description: Returns pairing details (scopes, status) for the console approve screen. The requesting machine name is withheld until approval to avoid leaking it on a guessed code. Rate-limited per actor.
tags:
- API Keys
security:
- BearerAuth: []
parameters:
- schema:
type: string
required: true
name: userCode
in: path
responses:
'200':
description: Pairing details
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
'404':
description: Pairing code not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
'429':
description: Too many pairing lookups
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
operationId: getApiKeysDeviceByUserCode
x-operation-id-source: derived
/api-keys/device/approve:
post:
summary: Approve CLI device login
description: Approves a pairing as the signed-in user, minting an API key for their default team and staging it for one-time CLI pickup.
tags:
- API Keys
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceUserCode'
responses:
'200':
description: Pairing approved
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- timestamp
'400':
description: Invalid or expired pairing
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
operationId: postApiKeysDeviceApprove
x-operation-id-source: derived
/api-keys/device/deny:
post:
summary: Deny CLI device login
description: Denies a pairing so the CLI stops polling.
tags:
- API Keys
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceUserCode'
responses:
'200':
description: Pairing denied
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data: {}
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- timestamp
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
timestamp:
type: string
example: '2026-11-09T19:02:47.358Z'
required:
- success
- error
- timestamp
operationId: postApiKeysDeviceDeny
x-operation-id-source: derived
components:
schemas:
DeviceUserCode:
type: object
properties:
userCode:
type: string
minLength: 1
required:
- userCode
PollDeviceAuth:
type: object
properties:
deviceCode:
type: string
minLength: 1
required:
- deviceCode
CreateApiKey:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
scopes:
type: array
items:
type: string
enum:
- read
- deploy
- full
- storage
minItems: 1
expiresAt:
type:
- string
- 'null'
format: date-time
required:
- name
- scopes
StartDeviceAuth:
type: object
properties:
clientName:
type: string
minLength: 1
maxLength: 120
scopes:
type: array
items:
type: string
enum:
- read
- deploy
- full
- storage
minItems: 1
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: aq_sk_ API key
description: 'An Aquanode API key, created under API keys in the console, sent as `Authorization: Bearer aq_sk_...` (or in the `x-api-key` header). A key is scoped to the team that created it; mutating routes need a key with the `deploy` or `full` scope.'