Skip to main content
POST
Create Endpoint

Headers

Content-Type
string
required

Allowed value: application/json.

Authorization
string
required

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

Body

application/json
type
enum<string>
required

Endpoint type. Allowed values: sync, async.

Available options:
sync,
async
Example:

"sync"

name
string
required

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

Example:

"example-endpoint"

product_id
string
required

Serverless product ID. String, length: 1-255 characters.

Example:

"product-id"

image
string
required

Image address. String, length: 1-500 characters.

Example:

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

worker_config
object
required

Worker configuration.

app_name
string

Application name. String, length: 0-255 characters.

Example:

"example-app"

registry_auth_id
string

Saved registry authentication ID. String, length: 0-255 characters.

Example:

"registry-auth-id"

entrypoint
string

Container entrypoint.

Example:

""

command
string

Startup command.

Example:

""

policy
object

Scheduling / request policy.

volumes
object[]

Mount list.

envs
object[]

Environment variable list.

ports
integer[]

Port list. Each value in range: [1, 65535].

Example:
health_check
object

Health check configuration.

region_id
string

Region ID.

Example:

"region-id"

Response

200 - application/json

OK

id
string

ID of the created Endpoint

Example:

"endpoint-id"

Last modified on June 23, 2026