Sign in
Private Link Attachments (networking/v1)

Update a Private Link Attachment

General Availability

Make a request to update a private link attachment.

patch/networking/v1/private-link-attachments/{id}

Path parameters

idstring required

The unique identifier for the private link attachment.

Request body

api_version'networking/v1'

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

kind'PrivateLinkAttachment'

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/private-link-attachments/platt-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-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-aws-us-east1",
    "cloud": "AWS",
    "region": "us-east-1",
    "environment": {
      "id": "env-00000"
    }
  },
  "status": {
    "phase": "READY",
    "dns_domain": "us-east-1.aws.private.confluent.cloud",
    "cloud": {
      "private_link_service": {
        "private_link_service_alias": "pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice",
        "private_link_service_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef"
      }
    }
  }
}

Response

Private Link Attachment.

api_version'networking/v1' required

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

kind'PrivateLinkAttachment' 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/private-link-attachments/platt-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-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-aws-us-east1",
    "cloud": "AWS",
    "region": "us-east-1",
    "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",
    "dns_domain": "us-east-1.aws.private.confluent.cloud",
    "cloud": {
      "private_link_service": {
        "private_link_service_alias": "pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice",
        "private_link_service_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef"
      }
    }
  }
}

Changes

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