Skip to content

Native access

Connection details, clouds.yaml and console links for each location.

Paths are relative to your API address. See Authentication.

Request and response examples are generated from the schema; the tables under Schemas are the reference.

Download clouds.yaml

GET /v1/orgs/{org_id}/projects/{project_id}/clouds.yaml

A clouds.yaml for the OpenStack CLI with an entry per location of the project, or for one location with placement. It holds no password or token: the CLI signs in through your browser.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
org_id path string No
placement query string Yes
project_id path string No

Responses

"string"

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Get connection details

GET /v1/orgs/{org_id}/projects/{project_id}/placements/{placement_id}/connection

The settings the OpenStack CLI and other tools need to sign in to this project in one location: sign-in address, region, identity provider, protocol, client and project ID. Contains no secret.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
org_id path string No
placement_id path string No
project_id path string No

Responses

{
    "auth_type": "string",
    "auth_url": "string",
    "client_id": "string",
    "discovery_endpoint": "string",
    "identity_api_version": 0,
    "identity_provider": "string",
    "interface": "string",
    "location": "string",
    "native_access": true,
    "project_id": "string",
    "protocol": "string",
    "region": "string"
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

GET /v1/orgs/{org_id}/projects/{project_id}/placements/{placement_id}/console

A link into the location's own web console for this project, or, with server, straight to that instance's page there. native_access says whether the caller can sign in to it.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
org_id path string No
placement_id path string No
project_id path string No
server query string Yes

Responses

{
    "deployment": "string",
    "kind": "string",
    "label": "string",
    "location": "string",
    "native_access": true,
    "project_id": "string",
    "region": "string",
    "url": "string",
    "websso": "verified"
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Schemas

Connection

Name Type Description
auth_type string The device-flow sign-in plugin.
auth_url string
client_id string
discovery_endpoint string
identity_api_version integer
identity_provider string | null
interface string
location string
native_access boolean Whether the caller holds a role that lets them in.
project_id string The project's ID in the location.
protocol string | null
region string | null
Name Type Description
deployment string
kind string horizon or skyline.
label string Words for the link: `Open in Horizon`, or in Skyline.
location string
native_access boolean Whether the caller holds a role that lets them in.
project_id string The project's ID in the location.
region string | null
url string
websso string What the location's last check of the console's sign-in found.

HTTPValidationError

Name Type Description
detail Array<ValidationError>

ValidationError

Name Type Description
ctx
input
loc Array<>
msg string
type string