Sign in
Regions (srcm/v2)

Read a Region

Deprecated

Make a request to read a region.

get/srcm/v2/regions/{id}

Path parameters

idstring required

The unique identifier for the region.

Response

Region.

api_version'srcm/v2' required

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

kind'Region' 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/srcm/v2/regions/sgreg-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-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": "Ohio (us-east-2)",
    "cloud": "AWS",
    "region_name": "us-east-2",
    "packages": [
      "ESSENTIALS",
      "ADVANCED"
    ]
  }
}

Changes

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