Method: organizations.getSystem

Gets the current state of the portal application.

HTTP request

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

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 (SystemStateData)
  },
  "message": string,
  "requestId": string,
  "status": string,
  "errorCode": string
}
Fields
data

object (SystemStateData)

Details of the system state.

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

SystemStateData

JSON representation
{
  "features": [
    string
  ],
  "systemAccessLevelMessage": string,
  "systemAccessTtl": integer,
  "systemStateAccessLevel": enum (SystemStateAccessLevel)
}
Fields
features[]

string

List of portal features.

systemAccessLevelMessage

string

System access level message.

systemAccessTtl

integer

System access time-to-live (TTL).

systemStateAccessLevel

enum (SystemStateAccessLevel)

System access level.

SystemStateAccessLevel

System access level values.

Enums
SYSTEM_STATE_ACCESS_LEVEL_UNSPECIFIED
NORMAL
READONLY
NO_PORTAL_CREATE