Sign in
Regions (srcm/v2)

List of Regions

Deprecated

Retrieve a sorted, filtered, paginated list of all regions.

get/srcm/v2/regions

Query parameters

spec.cloudstring

Filter a collection by a string search

Filter the results by exact match for spec.cloud.

spec.region_namestring

Filter a collection by a string search

Filter the results by exact match for spec.region_name.

spec.packagesstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.packages. Pass multiple times to see results matching any of the values.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Region.

api_version'srcm/v2' required

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

kind'RegionList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/srcm/v2/regions",
    "last": "https://api.confluent.cloud/srcm/v2/regions?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/srcm/v2/regions?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/srcm/v2/regions?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "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.