Jump to

• Request
• Response

Search for monitoring credentials

post

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

Searches for matching monitoring credentials based on the filters provided in the request payload.

Request

Query Parameters

• includeTotal: boolean
  whether total number of results shall be returned.

  Example:

  true

• limit: integer
  Minimum Value: 1

  Maximum Value: 2000

  Number of Monitoring credentials to be fetched

  Default Value: 20

  Example:

  20

• page: string
  system generated page token used in the self, next and previous links.
• sort: string
  the order of the result set with direction. Allowed sort fields are targetTypeName, setName. Allowed directions are ASC and DESC. To sort more than one field, provide comma separated values like field1:direction1,field2:direction2

  Example:

  type:ASC,name:DESC

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Schema object to hold Monitoring Credential search payload

Show Source

• setName: array setName
  credential set name
• setNameContains: array setNameContains
  Preferred credential set name pattern to be filtered. Case sensitive.
• targetName: array targetName
  target name of monitoring credential
• targetNameContains: array targetNameContains
  Monitoring credetnail target name to be filtered
• targetTypeName: array targetTypeName
  targetType of monitoring credential
• targetTypeNameContains: array targetTypeNameContains
  target type name to be filtered

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential search payload",
    "properties":{
        "targetNameContains":{
            "type":"array",
            "description":"Monitoring credetnail target name to be filtered",
            "items":{
                "type":"string",
                "example":"myHostName1, myHostName2"
            }
        },
        "targetTypeNameContains":{
            "type":"array",
            "description":"target type name to be filtered",
            "items":{
                "type":"string",
                "example":"type1, type2"
            }
        },
        "setNameContains":{
            "type":"array",
            "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
            "items":{
                "type":"string",
                "example":"set1, set2"
            }
        },
        "setName":{
            "type":"array",
            "description":"credential set name",
            "items":{
                "type":"string",
                "example":"CREDSET1, CREDSET2"
            }
        },
        "targetName":{
            "type":"array",
            "description":"target name of monitoring credential",
            "items":{
                "type":"string",
                "example":"www.myhost.com1, www.myhost.com2"
            }
        },
        "targetTypeName":{
            "type":"array",
            "description":"targetType of monitoring credential",
            "items":{
                "type":"string",
                "example":"host1, host2"
            }
        }
    }
}

Nested Schema : setName

Type: array

credential set name

Show Source

• Array of: string
  Example: CREDSET1, CREDSET2

{
    "type":"array",
    "description":"credential set name",
    "items":{
        "type":"string",
        "example":"CREDSET1, CREDSET2"
    }
}

Nested Schema : setNameContains

Type: array

Preferred credential set name pattern to be filtered. Case sensitive.

Show Source

• Array of: string
  Example: set1, set2

{
    "type":"array",
    "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
    "items":{
        "type":"string",
        "example":"set1, set2"
    }
}

Nested Schema : targetName

Type: array

target name of monitoring credential

Show Source

• Array of: string
  Example: www.myhost.com1, www.myhost.com2

{
    "type":"array",
    "description":"target name of monitoring credential",
    "items":{
        "type":"string",
        "example":"www.myhost.com1, www.myhost.com2"
    }
}

Nested Schema : targetNameContains

Type: array

Monitoring credetnail target name to be filtered

Show Source

• Array of: string
  Example: myHostName1, myHostName2

{
    "type":"array",
    "description":"Monitoring credetnail target name to be filtered",
    "items":{
        "type":"string",
        "example":"myHostName1, myHostName2"
    }
}

Nested Schema : targetTypeName

Type: array

targetType of monitoring credential

Show Source

• Array of: string
  Example: host1, host2

{
    "type":"array",
    "description":"targetType of monitoring credential",
    "items":{
        "type":"string",
        "example":"host1, host2"
    }
}

Nested Schema : targetTypeNameContains

Type: array

target type name to be filtered

Show Source

• Array of: string
  Example: type1, type2

{
    "type":"array",
    "description":"target type name to be filtered",
    "items":{
        "type":"string",
        "example":"type1, type2"
    }
}

Examples

Select an example Request Payload 1 Request Payload 2 Request Payload 3

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of monitoring credentials returned successfully

Body ()

Root Schema : MonitoringCredentialCollection

Type: object

This is the representation of list of monitoring credentials.

Show Source

• count(required): integer
  the number of Monitoring credentials in this page

  Example: 20
• items(required): array items
  the Preferred credentials list
• links(required): object links
  Read Only: true

  the result set navigation links
• total: integer
  Total number of items that are available (for all the pages)

  Example: 101

{
    "description":"This is the representation of list of monitoring credentials.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of Monitoring credentials in this page",
            "example":20
        },
        "total":{
            "type":"integer",
            "description":"Total number of items that are available (for all the pages)",
            "example":101
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the Preferred credentials list",
            "items":{
                "$ref":"#/components/schemas/MonitoringCredential"
            }
        }
    }
}

Nested Schema : items

Type: array

the Preferred credentials list

Show Source

• Array of: object MonitoringCredential
  A monitoring credential is used to describe which credential set and attributes is used to access a target.

{
    "type":"array",
    "description":"the Preferred credentials list",
    "items":{
        "$ref":"#/components/schemas/MonitoringCredential"
    }
}

Nested Schema : links

Type: object

Read Only: true

the result set navigation links

Show Source

• next: next
• previous: previous
• self: self

{
    "type":"object",
    "readOnly":true,
    "description":"the result set navigation links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
                    }
                }
            ]
        }
    }
}

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

Nested Schema : next

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
            }
        }
    ]
}

Nested Schema : previous

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
            }
        }
    ]
}

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
            }
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Examples

Select an example Response 1 Response 2 Response 3

Back to Top