Region

API for region operations

Version: 0.1.0

Server

URL: https://api.kopernik.us/v0
- Kopernik.us API server

Paths

/resource/region/{providerUid}

GET

List regions

List regions for the specified provider. Note: availabilityZones field is only populated for single region queries, and may be not present for list queries.

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
nextToken	query	string	❌	Token for the next page of regions, if there are more items to fetch
maxResults	query	integer	❌	Maximum number of regions to fetch
jq	query	string	❌	JQ filter expression to filter the results. Only resources where the expression evaluates to a truthy value are included. The expression is applied to each resource’s JSON representation. Uses jq 1.7 syntax.

Responses:

200: Regions list
- Content Type: application/json - Schema: RegionPagedResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Provider not found
- Content Type: application/json - Schema: ErrorResponse

/resource/region/{providerUid}/{resourceUid}

GET

Get region

Get region details

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
resourceUid	path	string	✅	Unique identifier of the region

Responses:

200: Region details
- Content Type: application/json - Schema: RegionResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Region not found
- Content Type: application/json - Schema: ErrorResponse

Schemas

Region

Composition: allOf

Resource

Type: object

Properties:

Name	Type	Required	Description
name	string	✅	Name of the region
country	string	✅	Country of the region
geoRegion	string	✅	Geo region of the region
capabilities	object	✅	Capabilities of the region
availabilityZones	array<AvailabilityZone>	❌	Availability zones of the region; for performance reasons this field is only populated for single region queries, and may be not present for list queries

Properties of capabilities:

Name	Type	Required	Description
available	boolean	❌	Whether the region is available for new resources
supportedServices	array<ResourceType>	❌	Supported services in the region

AvailabilityZone

A logical partition of a data center that is used to isolate resources

Type: object

Properties:

Name	Type	Required	Description
name	string	✅	Name of the availability zone

RegionResourceResponse

Response with region

Composition: allOf

ResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resource	Region	✅

RegionPagedResourceResponse

Response with paged regions

Composition: allOf

PagedResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resources	array<Region>	✅