Page contents

Provider

List available cloud providers. We use “provider” in this sense to refer to a major compute platform like Amazon AWS, GCP (Google Compute Platform), or Microsoft Azure.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

List providers

List available cloud providers.

GET /providers

Request

cURL example

curl -X GET https://api.crunchybridge.com/providers
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Response from listing providers.

Content type: application/json

Name Nullable Type Description
providers array of object of type Provider

Providers is the list of available cloud providers.

Example

{
    "providers": [
        {
            "disk": {
                "rate": 10
            },
            "display_name": "AWS",
            "id": "aws",
            "plans": [
                {
                    "cpu": 1,
                    "display_name": "Hobby-2",
                    "id": "hobby-2",
                    "memory": 2,
                    "rate": 3500
                }
            ],
            "regions": [
                {
                    "display_name": "US East",
                    "id": "us-east-1",
                    "location": "N. Virginia",
                    "multiplier": 1
                }
            ]
        }
    ]
}

The Provider object

Provider contains the information about a specific cloud provider, including how it should appear in the APIs and any billing plan information

Name Nullable Type Description
id string

Primary ID for the provider.
disk object of type Disk

Disk is the disk information for a provider.
display_name string

The provider’s public display name.
plans array of object of type Plan

Plans contains a list of plans available with the provider.
regions array of object of type Region

Regions contains a list of regions available with the provider.

Example

{
    "disk": {
        "rate": 10
    },
    "display_name": "AWS",
    "id": "aws",
    "plans": [
        {
            "cpu": 1,
            "display_name": "Hobby-2",
            "id": "hobby-2",
            "memory": 2,
            "rate": 3500
        }
    ],
    "regions": [
        {
            "display_name": "US East",
            "id": "us-east-1",
            "location": "N. Virginia",
            "multiplier": 1
        }
    ]
}

The Disk object

Disk contains information on drive offerings for the providers.

Name Nullable Type Description
rate integer

Rate is the price rate for the disk per gigabyte.

The Plan object

Plan contains information specific to a billable plan on a cloud provider.

Name Nullable Type Description
id string

Primary ID for the plan.
cpu integer

The number of CPU cores on the plan’s instance.
display_name string

The plan’s public display name.
memory number

The amount of memory on the plan’s instance in gigabytes.
rate integer

The cost of the plan in cents.

Example

{
    "cpu": 1,
    "display_name": "Hobby-2",
    "id": "hobby-2",
    "memory": 2,
    "rate": 3500
}

The Region object

Region contains information about a specific to a region, such as the provider's name for the it, display name, and the like.

Name Nullable Type Description
id string

Primary ID for the region.
display_name string

The region’s public name.
location string

Location is the name of the city or state where the region is hosted.
multiplier number

Multiplier is the price multiplier relative to the base cost of any particular plan in the region.

Example

{
    "display_name": "US East",
    "id": "us-east-1",
    "location": "N. Virginia",
    "multiplier": 1
}