Discover DB2 Instances and Databases Automatically

This operation is used to enable automatic discovery of DB2 Instances and the databases present inside the DB2 instances once the instance is configured

application/json

Request Body

• association object

  entity object[]

  clientId integer required

  ID of the client

  applicationId integer required

  Possible values: [37, 62]

  application ID for DB2 Unix is 62 and application ID for DB2 windows is 37

  _type_ integer
• agentProperties object

  db2Prop object

  isAutoDiscoveredEnabled boolean required

  True to enable auto discovery / False to disable auto discovery

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  errorCode integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0
    }
  ]
}

Bad Request

text/html

• Schema
• Example (from schema)
• Example 1

---

Schema

• object

{}

Request body is empty or format is invalid.

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to set Application properties.",
  "errorCode": 1
}

POST /agent    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• API request to enable Auto Discovery

---

{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientId": 0,
        "applicationId": 37,
        "_type_": 0
      }
    ]
  },
  "agentProperties": {
    "db2Prop": {
      "isAutoDiscoveredEnabled": true
    }
  }
}'