Get Psc

Get Psc

Retrieve details of a Platform Service Controller (PSC)

Request
URI
GET
https://{api_host}/v1/pscs/{id}
COPY
Path Parameters
string
id
Required

PSC ID

Responses
200

Ok

Returns Psc of type(s) application/json 
{
    "id": "string",
    "fqdn": "string",
    "ipAddress": "string",
    "ssoDomainName": "string",
    "ssoSubDomainName": "string",
    "isReplica": false,
    "domain": {
        "id": "string",
        "name": "string",
        "type": "string"
    }
}
string
id
Optional

ID of the Psc

string
fqdn
Optional

FQDN of the Psc

string
ipAddress
Optional

IP Address of the Psc

string
ssoDomainName
Optional

SSO Domain name of the Psc

string
ssoSubDomainName
Optional

SSO sub domain name of the Psc

boolean
isReplica
Optional

Indicates if the Psc is a replica

DomainReference
domain
Optional

Represents a domain reference


404

Psc not found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


On This Page
Pscs Operations
GET
Get Psc
GET
Get Pscs