Skip to main content

Get a Managed Client

GET 

/managed-clients/:id

Get a Managed Client.

Request

Path Parameters

    id stringrequired

    Managed Client ID.

    Example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7

Responses

Responds with a Managed Client

Schema
    id stringnullable

    ManagedClient ID

    alertKey stringnullable

    ManagedClient alert key

    ccId int64nullable

    Previous CC ID to be used in data migration. (This field will be deleted after CC migration!)

    clientId stringrequired

    The client ID used in API management

    clusterId stringrequired

    Cluster ID that the ManagedClient is linked to

    description stringrequired

    ManagedClient description

    ipAddress stringnullable

    The public IP address of the ManagedClient

    lastSeen date-timenullable

    When the ManagedClient was last seen by the server

    name stringnullable

    Default value: VA-$clientId

    ManagedClient name

    sinceLastSeen stringnullable

    Milliseconds since the ManagedClient has polled the server

    status stringnullable

    Possible values: [NORMAL, UNDEFINED, NOT_CONFIGURED, CONFIGURING, WARNING, ERROR, FAILED, null]

    Status of the ManagedClient

    type stringrequired

    Type of the ManagedClient (VA, CCG)

    clusterType stringnullable

    Possible values: [null, idn, iai, spConnectCluster, sqsCluster, das-rc, das-pc, das-dc]

    Cluster Type of the ManagedClient

    vaDownloadUrl stringnullable

    ManagedClient VA download URL

    vaVersion stringnullable

    Version that the ManagedClient's VA is running

    secret stringnullable

    Client's apiKey

    createdAt date-timenullable

    The date/time this ManagedClient was created

    updatedAt date-timenullable

    The date/time this ManagedClient was last updated

    provisionStatus stringnullable

    Possible values: [null, PROVISIONED, DRAFT]

    The provisioning status of the ManagedClient

Loading...