- URL:https://<root>/cloud/providers
- Child Resources:Provider
- Required Capability:Default administrator role
- Version Introduced:11.2
Description
The providers resource returns a list of the cloud providers configured with the deployment, including the provider name, connection information, and provider ID.
Note:
Its recommended that deployments update their cloud provider credentials at regular intervals if their cloud providers utilize a key-based authentication model. Credential information can be updated using the Update Credentials operation, which requires the values included in the credential JSON object that is returned by this resource.
Request parameters
Parameter | Details |
---|---|
maskedSecret | Determines how the encrypted secret key is returned. When true, the output shows the encrypted secret key with the last four characters in clear text. When false, the secret key is completely encrypted. The secret key is fully encrypted by default. Values: true | false |
f | The response format. The default format is pjson. Values: json | pjson |
Example usage
The following is a sample request URL used to access the providers resource:
https://organization.domain.com/context/admin/cloud/providers?maskedSecret=true&f=pjson
JSON Response example
The following sample JSON response is returned when either maskedSecret is set as false, or maskedSecret is not included in the request:
{
"cloudProviders": [
{
"cloudServices": [
{
"providerId": "xxmrejycd2",
"usage": "DEFAULT",
"name": "AWS S3",
"connection": {
"bucketName": "cloud-native-store",
"rootDir": "arcgis",
"region": "us-east-2"
},
"id": "jy568v1fhn",
"type": "objectStore",
"category": "storage"
}
],
"credential": {
"secret": {
"secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
"accessKey": "{crypt}+1FSvRmPvGDJXo1FY5ug9vcxrlAuZ+QN"
},
"type": "ACCESS-KEY"
},
"name": "AWS",
"id": "xxmrejycd2"
}
]
}
The sample JSON below is returned when maskedSecret is set as true:
{
"cloudProviders": [
{
"cloudServices": [
{
"providerId": "s7my5d949q",
"usage": "DEFAULT",
"name": "AWS S3",
"connection": {
"bucketName": "cloud-native-store",
"rootDir": "arcgisecs",
"region": "us-east-2"
},
"id": "wpjkp9s7ub",
"type": "objectStore",
"category": "storage"
}
],
"credential": {
"secret": {
"secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
"accessKey": "xxxxxxxxxxxxxxxxAZXL"
},
"type": "ACCESS-KEY"
},
"name": "AWS",
"id": "s7my5d949q"
}
]
}