Jump to

• Request
• Response

Get All Configurations for Control Plane

get

/api/v1/configuration/cpConfig

Get all available configurations for the control plane.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CpConfigMap

Type: object

Control plane configuration map

Show Source

• activeLdapId(optional): string
  Active LDAP configuration ID
• additionalProperties(optional): string
  Other Control Plane Config name and value pairs
• controlPlaneId(optional): string
  Blockchain Platform Manager ID

{
    "description":"Control plane configuration map",
    "type":"object",
    "properties":{
        "controlPlaneId":{
            "type":"string",
            "description":"Blockchain Platform Manager ID"
        },
        "activeLdapId":{
            "type":"string",
            "description":"Active LDAP configuration ID"
        },
        "additionalProperties":{
            "type":"string",
            "description":"Other Control Plane Config name and value pairs"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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"
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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