Modify Credential

This operation can be used to update the credential of an RDS instance.

Path Parameters

• Instance string required

  id of the Instance.

application/json

Request Body

• instanceProperties object

  cloudAppsInstance object

  instanceType string required

  Default value: AMAZON_RDS

  generalCloudProperties object

  credentials object

  credentialName string required

  Name of the credential.

  amazonInstanceInfo object

  useIamRole boolean required

  Set to True if IAM Rule needs to be used.

• association object

  entity object[]

  clientName string required

  Name of the Cloud Account.

  instanceName string required

  Name of RDS instance.

  displayName string required

  Display Name of Cloud account.

  appName string required

  Possible values: [Cloud Apps]

Responses

• 200
• 201

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

Created

POST /instance/:instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Instance — path required

Body

• Default
• Update access key and secret key
• Update IAM Role
• Update STS Assume role with IAM Poilcy

---

{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}

Accept

application/jsonapplication/xml

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS",
      "generalCloudProperties": {
        "credentials": {
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      }
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "Cloud Apps"
      }
    ]
  }
}'