Jump to

• Request
• Response

Test the monitoring credential against parameters

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/actions/testMonitoringCredential

The monitoring credential is tested against the provided set name, target type and target name or target instance ID.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Schema object to hold Monitoring Credential details for test action.

Match All

Show Source

• object TargetAndSetCommon
  Input for creating a Monitoring Credential

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential details for test action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetAndSetCommon"
        }
    ]
}

Nested Schema : TargetAndSetCommon

Type: object

Input for creating a Monitoring Credential

Show Source

• setName(required): string
  credential set name

  Example: CREDSET1
• targetGuid: string
  Target instance id of a preferred credential.

  Example: A3CDDE587FD221E2F3539013290B7F05
• targetName: string
  target name of monitoring credential

  Example: www.myhost.com
• targetTypeName: string
  name of the target type of the monitoring credential

  Example: oracle_database

{
    "type":"object",
    "required":[
        "setName"
    ],
    "description":"Input for creating a Monitoring Credential",
    "properties":{
        "setName":{
            "type":"string",
            "description":"credential set name",
            "example":"CREDSET1"
        },
        "targetTypeName":{
            "type":"string",
            "description":"name of the target type of the monitoring credential",
            "example":"oracle_database"
        },
        "targetName":{
            "type":"string",
            "description":"target name of monitoring credential",
            "example":"www.myhost.com"
        },
        "targetGuid":{
            "type":"string",
            "description":"Target instance id of a preferred credential.",
            "example":"A3CDDE587FD221E2F3539013290B7F05"
        }
    }
}

Examples

Select an example Request Payload 1 Request Payload 2

Back to Top

Response

204 Response

Monitoring credential tested successfully

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top