Skip to main content
POST
create endpoint

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
endpoint_name
string

Name of the endpoint. Must be unique among your endpoints. If omitted, a random 8-character name is generated.

Required string length: 1 - 512
Example:

"my_endpoint"

min_load
number
default:0

Minimum active capacity to maintain, in load per second. 0 allows the endpoint to scale to zero active workers.

Required range: x >= 0
Example:

50

min_cold_load
number
default:0

Floor on the load used to size the total pool of active and inactive workers, in load per second.

Required range: x >= 0
Example:

0

target_util
number
default:0.9

Target ratio of anticipated load to active capacity. Lower values keep more spare capacity.

Required range: 0 <= x <= 1
Example:

0.75

cold_mult
number
default:3

Total capacity (active and inactive) to maintain, as a multiple of the active capacity target.

Required range: x >= 0
Example:

2

cold_workers
integer
default:5

Minimum number of workers (active and inactive) to maintain. Shown as Minimum Workers in the console. Must not be greater than max_workers.

Required range: x >= 0
Example:

5

max_workers
integer
default:20

Maximum number of workers (active and inactive) the serverless engine will recruit.

Required range: x >= 0
Example:

20

max_queue_time
number
default:30

Maximum seconds of expected queue time allowed to build up on each worker before new requests wait in the endpoint queue.

Example:

30

target_queue_time
number
default:10

Endpoint-wide queue time, in seconds, above which the serverless engine scales up aggressively. Must not be greater than max_queue_time.

Example:

10

inactivity_timeout
number

Seconds without queued or in-progress requests after which active workers are stopped down to the min_load floor. Not set by default. Once set, it can be changed but not removed.

Example:

600

endpoint_state
enum<string>
default:active

Initial state of the endpoint.

Available options:
active,
suspended,
stopped
Example:

"active"

Response

Success response

success
boolean
Example:

true

result
integer

The ID of the created endpoint

Example:

12345