Jump to

• Request
• Response

Test the connection status

post

https://{your_site_interface}/opa-hub/api/12.2.35/connections/{connection-serviceName}/status

This operation will perform a connection test. The request consists of an empty JSON object.

Request

Path Parameters

• connection-serviceName(required): string
  The service name.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    },
    "additionalProperties":false
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The connection was tested and the connection status returned.

Body ()

Root Schema : connectionStatus

Type: object

Show Source

• detail: string
  Read Only: true

  The detailed status of the connection.
• okFlag: boolean
  Read Only: true

  True if the connection test succeeded, otherwise false.
• summary: string
  Read Only: true

  Allowed Values: [ "No service", "No password", "Access test failed", "Access test passed" ]

  The summary status of the connection.
• timestamp: string (date-time)
  Read Only: true

  The date and time of the test.

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the test.",
            "readOnly":true
        },
        "okFlag":{
            "type":"boolean",
            "description":"True if the connection test succeeded, otherwise false.",
            "readOnly":true
        },
        "summary":{
            "type":"string",
            "description":"The summary status of the connection.",
            "readOnly":true,
            "enum":[
                "No service",
                "No password",
                "Access test failed",
                "Access test passed"
            ]
        },
        "detail":{
            "type":"string",
            "description":"The detailed status of the connection.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top