PUT
/
api
/
v1
/
gateways
/
{gateway_id}
/
services
/
{service_id}
{
  "created_at": "<string>",
  "credentials": {
    "allow_override": true,
    "aws_access_key_id": "<string>",
    "aws_secret_access_key": "<string>",
    "azure_client_id": "<string>",
    "azure_client_secret": "<string>",
    "azure_tenant_id": "<string>",
    "azure_use_managed_identity": true,
    "gcp_service_account_json": "<string>",
    "gcp_use_service_account": true,
    "header_name": "<string>",
    "header_value": "<string>",
    "param_location": "<string>",
    "param_name": "<string>",
    "param_value": "<string>"
  },
  "description": "<string>",
  "gateway_id": "<string>",
  "headers": {},
  "host": "<string>",
  "id": "<string>",
  "name": "<string>",
  "path": "<string>",
  "port": 123,
  "protocol": "<string>",
  "retries": 123,
  "tags": [
    "<string>"
  ],
  "type": "<string>",
  "updated_at": "<string>",
  "upstream": {
    "algorithm": "<string>",
    "created_at": "<string>",
    "gateway_id": "<string>",
    "health_checks": {
      "headers": {},
      "interval": 123,
      "passive": true,
      "path": "<string>",
      "threshold": 123
    },
    "id": "<string>",
    "name": "<string>",
    "tags": [
      "<string>"
    ],
    "targets": [
      {
        "credentials": {
          "allow_override": true,
          "aws_access_key_id": "<string>",
          "aws_secret_access_key": "<string>",
          "azure_client_id": "<string>",
          "azure_client_secret": "<string>",
          "azure_tenant_id": "<string>",
          "azure_use_managed_identity": true,
          "gcp_service_account_json": "<string>",
          "gcp_use_service_account": true,
          "header_name": "<string>",
          "header_value": "<string>",
          "param_location": "<string>",
          "param_name": "<string>",
          "param_value": "<string>"
        },
        "default_model": "<string>",
        "headers": {},
        "host": "<string>",
        "id": "<string>",
        "models": [
          "<string>"
        ],
        "path": "<string>",
        "port": 123,
        "priority": 123,
        "protocol": "<string>",
        "provider": "<string>",
        "tags": [
          "<string>"
        ],
        "weight": 123
      }
    ],
    "updated_at": "<string>"
  },
  "upstream_id": "<string>"
}

Path Parameters

​
gateway_id
string
required

Gateway ID

​
service_id
string
required

Service ID

Body

application/json
Updated service data
​
createdAt
string
​
credentials
object
​
description
string
​
gateway_id
string
​
headers
object
​
host
string
​
id
string
​
name
string
​
path
string
​
port
integer
​
protocol
string
​
retries
integer
​
tags
string[]
​
type
string
​
updatedAt
string
​
upstream_id
string

Response

200
application/json
Service updated successfully
​
created_at
string
​
credentials
object
​
description
string
​
gateway_id
string
​
headers
object
​
host
string

Direct configuration (used when type is "direct")

​
id
string
​
name
string
​
path
string
​
port
integer
​
protocol
string
​
retries
integer

Common settings

​
tags
string[]
​
type
string

"upstream" or "endpoint"

​
updated_at
string
​
upstream
object
​
upstream_id
string

Upstream configuration (used when type is "upstream")