fluke/devops-service/doc/provider.md
Tim Lianov 03dc3d8d99 v3
2018-04-04 22:44:39 +03:00

4.6 KiB

Provider API

Get providers list [GET /v3/providers]

Get devops providers

Request

  • Method: GET
  • Headers:
    • Accept: application/json

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    [
      "aws",
      "static",
      "openstack"
    ]

Get provider accounts [GET /v3/provider/:provider/accounts]

Get accounts list for provider ':provider'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    []

Create provider account [POST /v3/provider/:provider/account]

Create account for provider ':provider'

Request

  • Method: POST
  • Headers:
    • Accept: application/json
    • Content-Type: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
  • Body:
    []

Response

Status: 201

  • Headers:
    • Content-Type: application/json
  • Body:
    {
      "message": ""
    }

Get provider account [Get /v3/provider/:provider/account/:account]

Get account ':account' description for provider ':provider'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    {
    
    }

Status: 404

  • Headers:
    • Content-Type: application/json
  • Body:
    {
      "message": ""
    }

Delete provider account [Delete /v3/provider/:provider/account/:account]

Delete account ':account' for provider ':provider'

Request

  • Method: DELETE
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    {
      "message": ""
    }

Status: 404

  • Headers:
    • Content-Type: application/json
  • Body:
    {
      "message": ""
    }

Get aws vpcs [GET /v3/provider/aws/account/:account/vpcs]

Get vpcs list for provider 'aws' and account ':account'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :account - provider account

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    []

Get security groups [GET /v3/provider/:provider/account/:account/security_groups]

Get security groups list for provider ':provider' and account ':account'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account
    • vpc-id - vpc id for aws provider

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    {}

Get subnets [GET /v3/provider/:provider/account/:account/networks]

Get subnets list for provider ':provider' and account ':account'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account
    • vpc-id - vpc id for aws provider

Response


Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:

aws:

[
    {
      "cidr": "0.0.0.0/16",
      "vpcId": "vpc-1",
      "subnetId": "subnet-1",
      "name": "subnet-1",
      "zone": "us-east-1a"
    }
]

openstack:

[
    {
      "cidr": "0.0.0.0/16",
      "name": "private",
      "id": "b14f8df9-ac27-48e2-8d65-f7ef78dc2654"
    }
]

Get provider flavors [GET /v3/provider/:provider/account/:account/flavors]

Get flavors list for provider ':provider' and account ':account'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    {}

Get provider images [GET /v3/provider/:provider/account/:account/images]

Get images list for provider ':provider' and account ':account'

Request

  • Method: GET
  • Headers:
    • Accept: application/json
  • Params:
    • :provider - provider ("static", "aws", "openstack")
    • :account - provider account

Response

Status: 200

  • Headers:
    • Content-Type: application/json
  • Body:
    {}