Get Api Root

Get Api Root
Global API Root

This endpoint returns links to the APIs available on a given Cloud Foundry deployment.

Request
URI
GET
https://api.example.local/
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

{
    "links": {
        "self": {
            "href": "string",
            "method": "string"
        },
        "cloud_controller_v2": {
            "href": "string",
            "method": "string"
        },
        "cloud_controller_v3": "Link Object",
        "network_policy_v1": "Link Object",
        "uaa": "Link Object",
        "logging": "Link Object",
        "log_cache": "Link Object",
        "log_stream": "Link Object"
    }
}
object
links
Optional

Links to related resources


404

Not Found

Returns NotFound of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


500

Internal Server Error

Returns 500 of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/
On This Page
Root Operations
GET
Get Api Root
GET
Get V3 Api Root