Method: organizations.portals.getStatus

Gets a health check from the server.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*}/portals/status

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "data": {
    object (ServerStatusData)
  },
  "message": string,
  "requestId": string,
  "status": string,
  "errorCode": string
}
Fields
data

object (ServerStatusData)

Details of the server status.

message

string

Description of the operation.

requestId

string

ID that can be used to find request details in the log files.

status

string

Status of the operation.

errorCode

string

ID that can be used to find errors in the log files.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

ServerStatusData

JSON representation
{
  "nfsFolders": boolean,
  "nfsReadAccess": boolean,
  "nfsWriteAccess": boolean,
  "dbConnection": boolean,
  "dbUpdateLatest": boolean,
  "defaultSmtpSend": boolean,
  "edgeConnection": boolean,
  "idpConnection": boolean
}
Fields
nfsFolders

boolean

nfsReadAccess

boolean

nfsWriteAccess

boolean

dbConnection

boolean

dbUpdateLatest

boolean

defaultSmtpSend

boolean

edgeConnection

boolean

idpConnection

boolean