Help API

This page contains all endpoints for the Help API.

Every call requires your API Key to be sent via the X-Reseller-Api-Key header. A 401 UNAUTHORIZED status code will be sent back if credentials are missing.

The Help API gives you the listing of possible choices for all reference attributes. Reference attributes always have the suffix ‘_ref’.

Multiple endpoints can lead to the same implementation for the help API. This is done to ensure that calling the definitions of the reference field can be automated seamlessly.

GET /reseller/help/account/v2/billing_status/
GET /reseller/help/account/v1/billing_status/

Returns a list of all of the possible billing status a client can have with a description.

Status Codes:

Example Response

{
  "billing_status": [
    {
      "name": "valid",
      "description": "The billing situation of the client is valid and
        the client has access to the platform."
    }
  ]
}
GET /reseller/help/account/v2/contact_type/

Returns a list of all of the possible Contact types for a Client.

Example:

Status Codes:

Example Response

{
  "contact_types": [
    {
      "name": "primary"
    },
    {
      "name": "billing"
    },
    {
      "name": "tech"
    },
    {
      "name": "support"
    },
    {
      "name": "emergency"
    }
  ]
}
GET /reseller/help/admin/v2/country/
GET /reseller/help/account/v2/country/

Returns a list of all of the possible countries. Countries code use the two letters standard ISO 3166-1 alpha-2.

Status Codes:

Example Response

{
  "countries": [
    {
      "country_code": "ca",
      "name": "canada"
    },
    {
      "country_code": "ru",
      "name": "russian federation"
    }
  ]
}
GET /reseller/help/account/v2/locale/

Returns a list of all of the possible locale an entity can have. A locale is composed of both the language and the region associated with the language for proper localization. Language is represented by the ISO 369-1 followed by a hyphen and the ISO 3166-1 alpha-2 code for the country representing the locale.

Example: en-us for english localized to the United States, en-gb for english localized to the United Kingdom.

Status Codes:

Example Response

{
  "locales": [
    {
      "name": "en-us"
    },
    {
      "name": "en-gb"
    },
    {
      "name": "fr-fr"
    },
    {
      "name": "fr-ca"
    },
    {
      "name": "ru-ru"
    },
    {
      "name": "ja-jp"
    },
    {
      "name": "pt-br"
    },
    {
      "name": "pt-pt"
    },
    {
      "name": "es-es"
    }
  ]
}
GET /reseller/help/account/v2/state/

Returns a list of all of the possible country states. A state is represented by the ISO 3166-2 subdivision (provinces or state) standard, based on the ISO 3166-1 alpha-2 country code.

Example:

Status Codes:

Example Response

{
  "states": [
    {
      "state_code": "ca-qc",
      "country_code": "ca",
      "name": "quebec"
    },
    {
      "state_code": "us-tx",
      "country_code": "us",
      "name": "texas"
    }
  ]
}
POST /reseller/help/apps_api/validate_heat_template

Converts the received encoded template to JSON and validates the template.

Parameters:
  • template – Base64 string code of the yaml template.
Status Codes:

Note

Please refer to Openstack heat template guide for guidance on how to construct the heat template.

Example Request

{
    "template": "data:application/x-yaml;base64,aGVhdF90ZW1wbGF0Z...",
}

Example Response

{
    "Description": "Apache HTTP Server",
    "Parameters": {
        "os_public_endpoint": {
            "Type": "String",
            "Description": "Openstack public endpoint",
            "NoEcho": "false",
            "Label": "os_public_endpoint"
        },
        "image": {
            "Type": "String",
            "Description": "Glance image to be used for compute inst",
            "NoEcho": "false",
            "Label": "image",
            "Default": "ubuntu-18.04-amd64",
            "CustomConstraint": "glance.image"
        },
        "flavor": {
            "Type": "String",
            "Description": "Flavor",
            "NoEcho": "false",
            "Label": "flavor",
            "Default": 100,
            "CustomConstraint": "nova.flavor"
        },
        "subnet_net_id": {
            "Type": "String",
            "Description": "Private network",
            "NoEcho": "false",
            "Label": "subnet_net_id",
            "CustomConstraint": "neutron.network"
        },
        "subnet": {
            "Type": "String",
            "Description": "Private subnet",
            "NoEcho": "false",
            "Label": "subnet",
            "CustomConstraint": "neutron.subnet"
        },
        "floating_ip": {
            "Type": "String",
            "Description": "Floating IP",
            "NoEcho": "false",
            "Label": "Floating IP"
        },
        "floating_ip_id": {
            "Type": "String",
            "Description": "The ID of the floating IP",
            "NoEcho": "false",
            "Label": "Floating IP ID"
        },
        "volume_size": {
            "Type": "Number",
            "Description": "All your data will be stored in this...",
            "NoEcho": "false",
            "Label": "volume_size",
            "Default": 50
        },
        "volume_type": {
            "Type": "String",
            "Description": "Type of volume to use",
            "NoEcho": "false",
            "Label": "Volume Type"
        },
        "key": {
            "Type": "String",
            "Description": "SSH key",
            "NoEcho": "false",
            "Label": "key",
            "CustomConstraint": "nova.keypair"
        }
    },
    "Environment": {
        "resource_registry": {
            "resources": {}
        },
        "parameters": {},
        "parameter_defaults": {},
        "event_sinks": []
    }
}

Example Fail Response

{
    "code": 400,
    "title": "Bad Request",
    "explanation": "The server could not comply with the request...",
    "error": {
        "type": "InvalidSchemaError",
        "traceback": null,
        "message": "Missing parameter type for parameter: image"
    }
}