Skip to main content
GET
Get Endpoint

Headers

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Path Parameters

endpoint_id
string
required

Endpoint ID. String, length: 1-255 characters.

Response

200 - application/json

OK

id
string

Endpoint ID

Example:

"endpoint-id"

type
enum<string>

Endpoint type. Allowed values: sync, async

Available options:
sync,
async
name
string

Endpoint name

Example:

"example-endpoint"

app_name
string

Application name

Example:

"example-app"

status
object

Endpoint status

url
string

Access URL

Example:

"https://endpoint.example.com/endpoint-id"

product_id
string

Serverless product ID

worker_config
object

Worker configuration

Example:
policy
object

Policy configuration

Example:
image
string

Image address

Example:

"registry.example.com/namespace/image:tag"

registry_auth_id
string

Registry authentication ID

Example:

"registry-auth-id"

entrypoint
string

Container entrypoint

Example:

""

command
string

Startup command

Example:

"cargo run"

volumes
object[]

Mount list

Example:
envs
object[]

Environment variable list

Example:
ports
integer[]

Port list

Example:
workers
object[]

Worker list

health_check
object

Health check configuration

Example:
region_id
string

Region ID

Example:

"region-id"

member_id
string

Member ID

Example:

"member-id"

owner_id
string

Owner ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

created_at
integer

Creation time. Unix timestamp

Example:

1710000000

Last modified on June 26, 2026