Jump to

• Request
• Response

Test the named credential against the target

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/{namedCredentialId}/actions/test

Instance credentials are tested against the credential target, payload is not needed here. Global credentials are tested against the target provided, it needs the request payload. When the user has only the view target privileges, this API will return 403 error as the user won't be able to test the credential. When user wants to test the credential before saving and the target is down, this API will return 503.

Request

Path Parameters

• namedCredentialId(required): string
  Id of a named credential

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

This consists of data required to test a named credential

Show Source

• authenticationTestTargetName: string
  Test target name

  Example: testhost.example.com
• authenticationTestTargetTypeName: string
  Name of the test target type

  Example: host
• id: string
  Unique identifier for a named credential. Also passed as path parameter.

  Example: B0FBBE587FD201E2E0537013790A7D03

{
    "description":"This consists of data required to test a named credential",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a named credential. Also passed as path parameter.",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"testhost.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        }
    }
}

Back to Top

Response

204 Response

Named 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