Skip to main content
POST
Create an authenticated endpoint

Authorizations

Authorization
string
header
required

Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).

Headers

Idempotency-Key
string
required

Client-selected key of 8–180 characters [A-Za-z0-9:_-]. Reusing it for the same action and canonical request replays the original result. Reusing it with a different request returns 409 idempotency_conflict.

Required string length: 8 - 180
Pattern: ^[A-Za-z0-9:_-]+$

Path Parameters

id
string<uuid>
required

Body

application/json

Every public endpoint is authenticated; unauthenticated mode does not exist.

name
string
required
Required string length: 1 - 120
protocol
enum<string>
required
Available options:
https,
wss,
tcp
targetPort
integer
required
Required range: 1 <= x <= 65535
auth
object
required
expiresInSeconds
integer
Required range: 60 <= x <= 604800

Response

Accepted.

operation
object
required
endpoint
object
required
credential
object
required