Jump to

• Request
• Response

Create a monitoring credential

post

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

Creates a named credential as monitoring for the target type or target instance and set name provided in the payload.

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 data required in the setMonitoringCredential action.

Show Source

• authenticationTargetType: string
  The authenticating target type. Defaults to targetTypeName

  Example: host
• isAuthenticationRequired: boolean
  true if authentication is required before saving credential

  Example: false
• targetNames: array targetNames
  the targets list, if needed to set for multiple targets

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential data required in the setMonitoringCredential action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MonitoringCredentialCommon"
        }
    ],
    "properties":{
        "targetNames":{
            "type":"array",
            "description":"the targets list, if needed to set for multiple targets",
            "items":{
                "type":"string",
                "example":"com.my.host1, com.my.host2"
            }
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

Match All

Show Source

• object allOf MonitoringCredentialCommon
  Input for creating a Monitoring Credential

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential data required in the setMonitoringCredential action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MonitoringCredentialCommon"
        }
    ],
    "properties":{
        "targetNames":{
            "type":"array",
            "description":"the targets list, if needed to set for multiple targets",
            "items":{
                "type":"string",
                "example":"com.my.host1, com.my.host2"
            }
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

Nested Schema : targetNames

Type: array

the targets list, if needed to set for multiple targets

Show Source

• Array of: string
  Example: com.my.host1, com.my.host2

{
    "type":"array",
    "description":"the targets list, if needed to set for multiple targets",
    "items":{
        "type":"string",
        "example":"com.my.host1, com.my.host2"
    }
}

Nested Schema : MonitoringCredentialCommon

Type: object

Input for creating a Monitoring Credential

Show Source

• attributes(required): object attributes
  Additional Properties Allowed: additionalProperties

  Represents a map of name-value for the attributes for the monitoring credential
• credentialType(required): string
  credential type

  Example: HostSSHCreds

{
    "type":"object",
    "description":"Input for creating a Monitoring Credential",
    "required":[
        "credentialType",
        "attributes"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetAndSetCommon"
        }
    ],
    "properties":{
        "credentialType":{
            "type":"string",
            "description":"credential type",
            "example":"HostSSHCreds"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the monitoring credential",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Match All

Show Source

• object TargetAndSetCommon
  Input for creating a Monitoring Credential

{
    "type":"object",
    "description":"Input for creating a Monitoring Credential",
    "required":[
        "credentialType",
        "attributes"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetAndSetCommon"
        }
    ],
    "properties":{
        "credentialType":{
            "type":"string",
            "description":"credential type",
            "example":"HostSSHCreds"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the monitoring credential",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

Supported Media Types

• application/json

200 Response

Monitoring credential created successfully

Body ()

Root Schema : MonitoringCredential

Type: object

A monitoring credential is used to describe which credential set and attributes is used to access a target.

Show Source

• attributes: array attributes
  Additional Properties Allowed: additionalProperties

  the attributes of the credential
• authenticatingTargetType: string
  the authenticating target type of the set
• credentialType: string
  the credential type
• monitoringCredentialSetName: string
  the name of the credential set

{
    "x-em-sdk-level":"emSDK",
    "description":"A monitoring credential is used to describe which credential set and attributes is used to access a target.",
    "type":"object",
    "properties":{
        "monitoringCredentialSetName":{
            "description":"the name of the credential set",
            "type":"string"
        },
        "authenticatingTargetType":{
            "description":"the authenticating target type of the set",
            "type":"string"
        },
        "credentialType":{
            "description":"the credential type",
            "type":"string"
        },
        "attributes":{
            "description":"the attributes of the credential",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            },
            "example":[
                {
                    "name":"UserName",
                    "value":"MyUserName"
                },
                {
                    "name":"Password",
                    "value":"MyPassword"
                }
            ],
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Additional Properties Allowed

Show Source

• string

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

the attributes of the credential

Show Source

• Array of: object NameValuePair
  A pair of name and value.

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

Example:

[
    {
        "name":"UserName",
        "value":"MyUserName"
    },
    {
        "name":"Password",
        "value":"MyPassword"
    }
]

Nested Schema : NameValuePair

Type: object

A pair of name and value.

Show Source

• name: string
  the name
• value: string
  the value

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and value.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "value":{
            "description":"the value",
            "type":"string"
        }
    }
}

Examples

Select an example Response Payload 1

400 Response

Bad Request. The payload is null or missing some parameters

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"
        }
    }
}

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"
        }
    }
}

409 Response

Conflict

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