Find ExpressRouteGateways

GET 
/api/v1/projects/:projectId/azure/expressroutegateways

This ressource allows to find Express Route Gateways

Request

Path Parameters

projectId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

project Id

Query Parameters

azureCspCredentialId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

azure credential Id

azureResourceGroup stringrequired

Possible values: Value must match regular expression \S

azure resource group

Responses

200

ok

application/json

Schema

Schema

Array [
idstring
namestring
properties object
provisioningStatestring
gatewayTypestring
vpnGatewayGenerationstring
sku object
namestring
tierstring
familystring
vpnTypestring
enableBgpboolean
activeActiveboolean
ipConfigurations object[]
Array [
namestring
properties object
privateIPAllocationMethodstring
subnet object
idstring
publicIPAddress object
idstring
]
bgpSettings object
asnint64
bgpPeeringAddresses object[]
Array [
defaultBgpIpAddressesstring[]
]
locationstring
tags object
property name*string
]

Example (auto)

[
  {
    "id": "string",
    "name": "string",
    "properties": {
      "provisioningState": "string",
      "gatewayType": "string",
      "vpnGatewayGeneration": "string",
      "sku": {
        "name": "string",
        "tier": "string",
        "family": "string"
      },
      "vpnType": "string",
      "enableBgp": true,
      "activeActive": true,
      "ipConfigurations": [
        {
          "name": "string",
          "properties": {
            "privateIPAllocationMethod": "string",
            "subnet": {
              "id": "string"
            },
            "publicIPAddress": {
              "id": "string"
            }
          }
        }
      ],
      "bgpSettings": {
        "asn": 0,
        "bgpPeeringAddresses": [
          {
            "defaultBgpIpAddresses": [
              "string"
            ]
          }
        ]
      }
    },
    "location": "string",
    "tags": {}
  }
]

400

bad request

application/json

Schema

Schema

codeint32
bad request code
messagestring
bad request message
descriptionstring
bad request description
violations object[]
bad request violations
Array [
fieldstring
field
messagestring
message
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

unauthorized access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

not found

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Authorization: http

name: SecuritySchemetype: httpdescription: Authenticationscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/api/v1/projects/:projectId/azure/expressroutegateways' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

/api/v1

Auth

Bearer Token

Parameters

projectId — pathrequired

azureCspCredentialId — queryrequired

azureResourceGroup — queryrequired