Service

List available service profiles

Returns the custom instance profiles the organization can use in a region. Pass byoc_id to list the profiles configured for a BYOC infrastructure; the region is then taken from the infrastructure and region_id may be omitted. The list is empty when the organization tier does not include custom hardware profiles.

get/v1/organizations/{organizationId}/serviceProfiles

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/serviceProfiles
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization to list available profiles for.

Query parameters

region_idstring

Region to list profiles for, e.g. us-east-1. Required unless byoc_id is set; when both are set it must match the BYOC infrastructure's region.

byoc_idstring uuid

ID of the BYOC infrastructure to list profiles for. BYOC profiles are only returned when this is set.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

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