Skip to main content
POST
Create Endpoint

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
min_load
number

Minimum load for the endpoint.

Example:

50

min_cold_load
number

Minimum cold load threshold below which cold workers are maintained.

Example:

0

target_util
number

Target utilization for the endpoint.

Example:

0.75

cold_mult
number

Multiplier for cold start.

Example:

2

cold_workers
integer

Number of cold workers.

Example:

5

max_workers
integer

Maximum number of workers.

Example:

20

max_queue_time
number

Maximum acceptable queue time in seconds before scaling up.

Example:

60

target_queue_time
number

Desired queue time in seconds that the autoscaler targets; must be <= max_queue_time.

Example:

10

autoscaler_instance
string

Autoscaler deployment environment to attach this endpoint to.

Example:

"prod"

endpoint_state
enum<string>

Initial activation state of the endpoint.

Available options:
active,
suspended,
stopped
Example:

"active"

endpoint_name
string

Name of the endpoint.

Example:

"my_endpoint"

inactivity_timeout
number

Seconds of inactivity after which the autoscaler may suspend the endpoint.

Example:

300

overrecruit_ratio
number

Ratio by which to over-recruit workers to absorb traffic spikes.

Example:

1.2

Response

Returns {success: true, result: <new_endpoint_id>}

success
boolean

Always true on success.

result
integer

ID of the newly created endpoint.