Providers

The providers endpoint allows you to retrieve infrastructure providers, and the regions and plans available for each.

The unique identifiers for provider, plan, and region are required to provision a new cluster with the API.

Listing providers

GET /providers

Request example

curl --request GET "https://api.crunchybridge.com/providers"\
    --header "Accept: application/json"\
    --header "Authorization: Bearer 22rpvk7jjdqfci6rjbrl24x5m"

Response example

Status code: 200 OK

{
  "providers": [
    {
      "id": "aws",
      "display_name": "AWS",
      "regions": [
        {
          "id": "us-east-1",
          "display_name": "US East",
          "location": "N. Virginia"
        },
        ...
        {
          "id": "eu-west-1",
          "display_name": "EU West 1",
          "location": "Ireland"
        }
      ],
      "plans": [
        {
          "id": "hobby-2",
          "display_name": "Hobby-2",
          "cpu": 1,
          "memory": 2
        },
        ...
        {
          "id": "memory-512",
          "display_name": "Memory-512",
          "cpu": 64,
          "memory": 512
        }
      ]
    },
    {
      "id": "azure",
      "display_name": "Azure",
      "regions": [
        {
          "id": "eastus2",
          "display_name": "East US",
          "location": "Virginia"
        },
	    ...
        {
          "id": "canadacentral",
          "display_name": "Canada Central",
          "location": "Toronto"
        }
      ],
      "plans": [
        {
          "id": "hobby-2",
          "display_name": "Hobby-2",
          "cpu": 1,
          "memory": 2
        },
	    ...
        {
          "id": "standard-256",
          "display_name": "Standard-256",
          "cpu": 64,
          "memory": 256
        }
      ]
    },
    {
      "id": "gcp",
      "display_name": "GCP",
      "regions": [
        {
          "id": "us-central1",
          "display_name": "US Central 1",
          "location": "Iowa"
        },
	    ...
        {
          "id": "australia-southeast1",
          "display_name": "Australia Southeast 1",
          "location": "Sydney"
        }
      ],
      "plans": [
        {
          "id": "hobby-2",
          "display_name": "Hobby-2",
          "cpu": 1,
          "memory": 2
        },
	    ...
        {
          "id": "standard-256",
          "display_name": "Standard-256",
          "cpu": 64,
          "memory": 256
        }
      ]
    }
  ]
}

Provider object

Attribute	Type	Description
`id`	string	Unique identifier for provider
`display_name`	string	Name of provider
`plans`	array of objects	Available plans with provider
`regions`	array of objects	Supported regions with provider

Plan object

Attribute	Type	Description
`id`	string	Unique identifier for plan
`display_name`	string	Plan name
`cpu`	integer	Number of vCores
`memory`	integer	Memory in GB

Region object

Attribute	Type	Description
`id`	string	Unique identifier for region
`display_name`	string	Name of region
`location`	string	Location