Sign in
Gateways (networking/v1)

Update a Gateway

General Availability

Make a request to update a gateway.

patch/networking/v1/gateways/{id}

Path parameters

idstring required

The unique identifier for the gateway.

Request body

api_version'networking/v1'

APIVersion defines the schema version of this representation of a resource.

kind'Gateway'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/networking/v1/gateways/gw-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "prod-gateway",
    "environment": {
      "id": "env-00000"
    }
  },
  "status": {
    "phase": "READY",
    "cloud_gateway": {
      "principal_arn": "arn:aws:iam::123456789012:cc-tenant-1-role"
    }
  }
}

Response

Gateway.

api_version'networking/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'Gateway' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/networking/v1/gateways/gw-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "prod-gateway",
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    }
  },
  "status": {
    "phase": "READY",
    "cloud_gateway": {
      "principal_arn": "arn:aws:iam::123456789012:cc-tenant-1-role"
    }
  }
}

Changes

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