AIaieev
Endpoints

Patch Endpoint Settings

Changed on

Update runtime settings for an inactive endpoint. At least one field must be provided. Stop the endpoint first if it is active.

patch/endpoints/{endpoint_id}

Request

  • Base URL
    https://external.aieev.cloud:5000/external/api/v1
  • URL
    https://external.aieev.cloud:5000/external/api/v1/endpoints/{endpoint_id}
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required

Unique endpoint ID.

Request body

container_start_commandstring nullable

Container start command.

container_portinteger nullable

Container service port (1-65535).

container_health_check_pathstring nullable

Health check endpoint path.

container_health_check_timeoutinteger nullable

Container health check timeout in seconds.

health_check_timeoutinteger nullable

Overall health check timeout in seconds. Deployment fails if health check does not pass within this time.

container_metric_pathstring nullable

Prometheus metrics endpoint path.

auth_mode'api_key' | 'oidc' | 'none' nullable

Authentication mode for the endpoint's public URL. api_key requires an AirCloud API key, oidc uses OIDC login, and none exposes the endpoint without AirCloud authentication.

Example request

{
  "container_start_command": "python app.py",
  "container_env_vars": [
    {
      "key": "ENV",
      "value": "prod"
    }
  ],
  "container_port": 8080,
  "container_health_check_path": "/healthz",
  "container_health_check_timeout": 30,
  "health_check_timeout": 300,
  "container_metric_path": "/metrics",
  "auth_mode": "api_key"
}

Response

Updated endpoint settings.

endpoint_idstring

Unique endpoint ID.

namestring

Endpoint name.

is_activeboolean

Active status (always false after successful patch).

container_start_commandstring nullable

Current start command.

container_env_varsobject[] nullable

Current environment variables.

container_portinteger nullable

Current port.

container_health_check_pathstring nullable

Current health check path.

container_health_check_timeoutinteger nullable

Current health check timeout.

health_check_timeoutinteger nullable

Current overall health check timeout.

container_metric_pathstring nullable

Current metric path.

auth_modestring nullable

Current authentication mode for the endpoint's public URL.

updated_atstring date-time

Update time.

Example response

{
  "auth_mode": "api_key"
}

Changes

  • 932394b3676bRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status