OCoctoml
endpoint

GET /v1/endpoint/{endpoint_name}

Return description of an endpoint

Request

Path parameters

endpoint_namestring required

The endpoint to retrieve

Response

A description of the endpoint

namestring required

Name of the endpoint

display_namestring

User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)

descriptionstring

Description of the endpoint

image_urlstring required

URL of the docker image

portinteger required

Port number of the endpoint

health_check_pathstring

URL path of a health check endpoint

auto_volume_experimentalboolean

EXPERIMENTAL: autogenerate a volume for the endpoint

min_replicasinteger

Minimum number of replicas

max_replicasinteger

Maximum number of replicas

scale_to_zerointeger

Time to scale to zero (in seconds)

registry_credentialstring

The key of a registry credential used to authenticate to a private registry

visibility'private' | 'public'

Visibility of the endpoint

endpoint_state'active' | 'disabled'

State of a endpoint

env_overridesobject

JSON object with environment variable overrides

instance_typestring

Endpoint to query against

container_secretsstring[]

A list of container secrets to inject as environment variables

concurrency_per_replicainteger

The maximum concurrency per replica

endpointstring

Endpoint to query against

Changes

No recorded changes to this operation across all 1 revision of this API.