Skip to content

Latest commit

 

History

History
182 lines (128 loc) · 7.33 KB

PlansApi.md

File metadata and controls

182 lines (128 loc) · 7.33 KB
Raw

equinix_metal.PlansApi

All URIs are relative to https://api.equinix.com/metal/v1

Method HTTP request Description
find_plans GET /plans Retrieve all plans
find_plans_by_project GET /projects/{id}/plans Retrieve all plans visible by the project

find_plans

PlanList find_plans(categories=categories, type=type, slug=slug, include=include, exclude=exclude)

Retrieve all plans

Provides a listing of available plans to provision your device on.

Example

  • Api Key Authentication (x_auth_token):
import equinix_metal
from equinix_metal.models.plan_list import PlanList
from equinix_metal.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = equinix_metal.Configuration(
    host = "https://api.equinix.com/metal/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: x_auth_token
configuration.api_key['x_auth_token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x_auth_token'] = 'Bearer'

# Enter a context with an instance of the API client
with equinix_metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = equinix_metal.PlansApi(api_client)
    categories = ['categories_example'] # List[str] | Filter plans by its category (optional)
    type = 'standard' # str | Filter plans by its plan type (optional)
    slug = 'c3.small.x86' # str | Filter plans by slug (optional)
    include = ['include_example'] # List[str] | Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. (optional)
    exclude = ['exclude_example'] # List[str] | Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. (optional)

    try:
        # Retrieve all plans
        api_response = api_instance.find_plans(categories=categories, type=type, slug=slug, include=include, exclude=exclude)
        print("The response of PlansApi->find_plans:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->find_plans: %s\n" % e)

Parameters

Name Type Description Notes
categories List[str] Filter plans by its category [optional]
type str Filter plans by its plan type [optional]
slug str Filter plans by slug [optional]
include List[str] Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. [optional]
exclude List[str] Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. [optional]

Return type

PlanList

Authorization

x_auth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 ok -
401 unauthorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_plans_by_project

PlanList find_plans_by_project(id, include=include, exclude=exclude)

Retrieve all plans visible by the project

Returns a listing of available plans for the given project

Example

  • Api Key Authentication (x_auth_token):
import equinix_metal
from equinix_metal.models.plan_list import PlanList
from equinix_metal.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = equinix_metal.Configuration(
    host = "https://api.equinix.com/metal/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: x_auth_token
configuration.api_key['x_auth_token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x_auth_token'] = 'Bearer'

# Enter a context with an instance of the API client
with equinix_metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = equinix_metal.PlansApi(api_client)
    id = 'id_example' # str | Project UUID
    include = ['include_example'] # List[str] | Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. (optional)
    exclude = ['exclude_example'] # List[str] | Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. (optional)

    try:
        # Retrieve all plans visible by the project
        api_response = api_instance.find_plans_by_project(id, include=include, exclude=exclude)
        print("The response of PlansApi->find_plans_by_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->find_plans_by_project: %s\n" % e)

Parameters

Name Type Description Notes
id str Project UUID
include List[str] Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. [optional]
exclude List[str] Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. [optional]

Return type

PlanList

Authorization

x_auth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 ok -
401 unauthorized -
403 forbidden -
404 not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]