Get description of an endpoint

GET

Return description of an endpoint

Path parameters

endpoint_namestringRequired

The endpoint to retrieve

Response

This endpoint returns an object

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

GET

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

200Retrieved

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

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

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