PingOne Platform APIs

Gateway Instances

Use these data models and requests to find and manage gateway instances resources.

Gateway instance view data model

A gateway instance represents a single Docker container that runs on-premise with the configuration for a gateway. PingOne provides a read-only view of the gateway’s status and identifying information.

Property Type Required? Mutable? Description

connected

Boolean

N/A

Read-only

Indicates whether or not the gateway instance has one or more connections.

credential.id

String

N/A

Read-only

The ID of the credential used by the gateway instance to create a websocket connection. The ID of the credential is the gateway credential’s jti claim.

currentErrors

String[]

N/A

Read-only

The messages that are maintained by the gateway instance.

gateway.id

String

Required

Immutable

The UUID for the gateway.

healthStatus

Enum

N/A

Read-only

Indicates whether or not the gateway is in a healthy state. Options are HEALTHY, UNHEALTHY.

hostname

String

N/A

Read-only

The hostname of the container running in the customer’s infrastructure.

id

String

Required

Immutable

The instance ID of the gateway. The gateway instance ID is created by the gateway when it starts up.

initializedAt

Date

N/A

Read-only

When the gateway was initialized (when the first connect to PingOne was made).

lastReportedAt

Date

N/A

Read-only

The last reported timestamp, heartbeat, or other message.

version

Object

N/A

Read-only

Contains the version of the gateway running for the instance.

version.versionNumber

String

N//A

Read-only

The version number of the gateway running for the instance.

version.updateStatus

Enum

N/A

Read-only

One of the following values:

  • AT_LATEST: The gateway instance’s version is at or after the supported version marked latest.

  • UPGRADE_AVAILABLE: The gateway instance’s version is at the supported version that is marked recommended but there is a later supported version marked recommended.

  • UPGRADE_RECOMMENDED: The gateway instance’s version is at a known version but the version is not marked as recommended or latest. The version has greater than 30 days support.

  • UPGRADE_REQUIRED: The gateway instance’s version is at a known version but the version is not marked as recommended or latest. The version has support ending within the next month.

  • NOT_SUPPORTED: The gateway instance’s version is not known or supported.

Gateway LDAP instance data model

Property Type Required? Mutable? Description

busyPercentage

Integer

N/A

Read-only

The gateway instance’s busy percentage. When this percentage is high, then more instances should be added.

operationsPerSecond

Integer

N/A

Read-only

The recent throughput of the gateway instance.

responseTimeMillis

Integer

N/A

Read-only

The processing time of the gateway instance in milliseconds.

LDAP instance resources represent a gateway instance running on-premise in the customer infrastructure. The resources are created by the gateway instance starting up and connecting to PingOne, which triggers the creation of the resource. If the gateway instance goes down, it is deleted on its own.

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

401

You do not have access to this resource.

404

The requested resource was not found.