Returns metadata about a specific cloud access provider

GET 
/api/v2/cloudaccess/meta/:name

Returns metadata about a specific cloud access provider

Request

Path Parameters

name stringrequired

Name of cloud provider

Responses

200

Metadata about the specified cloud access provider

application/json

Schema

Schema

cloudAccessTypes

undefined[]

required

Array [

description stringrequired

feature stringrequired

global booleanrequired

title stringrequired

]

credentialFields

undefined[]

required

Array [

description string

multiline booleanrequired

name stringrequired

required booleanrequired

sensitive booleanrequired

title stringrequired

]

name stringrequired

permissions

undefined[]

required

Array [

description string

feature string[]required

name stringrequired

providerRoleRequired booleanrequired

role stringrequired

]

Example (from schema)

{
  "cloudAccessTypes": [
    {
      "description": "string",
      "feature": "string",
      "global": true,
      "title": "string"
    }
  ],
  "credentialFields": [
    {
      "description": "string",
      "multiline": true,
      "name": "string",
      "required": true,
      "sensitive": true,
      "title": "string"
    }
  ],
  "name": "string",
  "permissions": [
    {
      "description": "string",
      "feature": [
        "string"
      ],
      "name": "string",
      "providerRoleRequired": true,
      "role": "string"
    }
  ]
}

401

If not authenticated

403

If authenticated but not authorized

404

the cloud provider with the given name doesn't exist

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...