List endpoints

Return list of endpoints

Response

This endpoint returns a list of objects.

namestring

Name of the endpoint

portinteger

Port number of the endpoint

replicaslist of objects

Active replicas for the endpoint

auto_volume_experimentalbooleanOptional

EXPERIMENTAL: autogenerate a volume for the endpoint

concurrency_per_replicaintegerOptional

The maximum concurrency per replica

container_secretslist of stringsOptional

A list of container secrets to inject as environment variables

descriptionstringOptionalDefaults to

Description of the endpoint

display_namestringOptionalDefaults to

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

endpointstringOptional

Endpoint to query against

endpoint_state"active" or "disabled"Optional

Allowed values: activedisabled

State of a endpoint

env_overridesmap from strings to anyOptional

JSON object with environment variable overrides

health_check_pathstringOptional

URL path of a health check endpoint

image_urlstringOptional

URL of the docker image

instance_typestringOptional

Endpoint to query against

max_replicasintegerOptional

Maximum number of replicas

min_replicasintegerOptional

Minimum number of replicas

registry_credentialstringOptional

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

scale_to_zerointegerOptional

Time to scale to zero (in seconds)

visibility"private" or "public"Optional

Allowed values: privatepublic

Visibility of the endpoint

volumes_experimentallist of objectsOptional

EXPERIMENTAL: volumes to be used by this container

1 curl https://api.octoai.cloud/v1/endpoints \ 2 -H "Authorization: Bearer <token>"

1 [ 2 { 3 "name": "name", 4 "port": 1, 5 "replicas": [ 6 { 7 "account_key": "account_key", 8 "endpoint_name": "endpoint_name", 9 "replica_id": "replica_id", 10 "status": "pending", 11 "restarts": 1, 12 "age": 1 13 } 14 ], 15 "auto_volume_experimental": true, 16 "concurrency_per_replica": 1, 17 "container_secrets": [ 18 "container_secrets" 19 ], 20 "description": "description", 21 "display_name": "display_name", 22 "endpoint": "endpoint", 23 "endpoint_state": "active", 24 "env_overrides": { 25 "key": "value" 26 }, 27 "health_check_path": "health_check_path", 28 "image_url": "image_url", 29 "instance_type": "instance_type", 30 "max_replicas": 1, 31 "min_replicas": 1, 32 "registry_credential": "registry_credential", 33 "scale_to_zero": 1, 34 "visibility": "private", 35 "volumes_experimental": [ 36 { 37 "name": "name", 38 "path": "path", 39 "mount": "mount" 40 } 41 ] 42 } 43 ]

1	curl https://api.octoai.cloud/v1/endpoints \
2	-H "Authorization: Bearer <token>"

1	[
2	{
3	"name": "name",
4	"port": 1,
5	"replicas": [
6	{
7	"account_key": "account_key",
8	"endpoint_name": "endpoint_name",
9	"replica_id": "replica_id",
10	"status": "pending",
11	"restarts": 1,
12	"age": 1
13	}
14	],
15	"auto_volume_experimental": true,
16	"concurrency_per_replica": 1,
17	"container_secrets": [
18	"container_secrets"
19	],
20	"description": "description",
21	"display_name": "display_name",
22	"endpoint": "endpoint",
23	"endpoint_state": "active",
24	"env_overrides": {
25	"key": "value"
26	},
27	"health_check_path": "health_check_path",
28	"image_url": "image_url",
29	"instance_type": "instance_type",
30	"max_replicas": 1,
31	"min_replicas": 1,
32	"registry_credential": "registry_credential",
33	"scale_to_zero": 1,
34	"visibility": "private",
35	"volumes_experimental": [
36	{
37	"name": "name",
38	"path": "path",
39	"mount": "mount"
40	}
41	]
42	}
43	]