Jump to

• Request
• Response

Get Available Configurations for Control Plane

get

/api/v1/configuration/cpConfig

Get all available configurations for the control plane.

Request

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CpConfigMap

Type: object

Public control plane configuration map. Server-managed controlPlaneId is omitted.

Show Source

• activeLdapId: string
  Allowed Values: [ "DEFAULT-LDAP-ID-001" ]

  The only supported LDAP identifier. Saving this value activates default LDAP before any provider has been activated.
• consoleIdleTimeout: string
  Timeout time (in minutes) of Idle CP
• notificationTimeout: string
  Timeout(in minutes) for notifications

{
    "description":"Public control plane configuration map. Server-managed controlPlaneId is omitted.",
    "type":"object",
    "properties":{
        "activeLdapId":{
            "type":"string",
            "enum":[
                "DEFAULT-LDAP-ID-001"
            ],
            "description":"The only supported LDAP identifier. Saving this value activates default LDAP before any provider has been activated."
        },
        "consoleIdleTimeout":{
            "type":"string",
            "description":"Timeout time (in minutes) of Idle CP"
        },
        "notificationTimeout":{
            "type":"string",
            "description":"Timeout(in minutes) for notifications"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top