Services

URL:: https://<root>/cloud/services
Methods:: GET
Child Resources:: Service
Required Capability:: Access allowed only with the default administrator role
Version Introduced:: 11.2

Description

The services resource returns a list of cloud services that have been configured with the deployment, returning the provider ID, provider name, connection information, and service ID.

Request parameters

Parameter Details

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`

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 services resource:

Use dark colors for code blocksCopy
https://organization.domain.com/context/admin/cloud/services?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:

Use dark colors for code blocksCopy
{
  "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"
    },
    {
      "providerId": "s7my5d949q",
      "usage": "BACKUP",
      "name": "AWS S3",
      "connection": {
        "bucketName": "cloud-native-store",
        "credential": {
          "secret": {
            "secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
            "accessKey": "{crypt}+1FSvRmPvGDJXo1FY5ug9vcxrlAuZ+QN"
          },
          "type": "ACCESS-KEY"
        },
        "rootDir": "backups",
        "region": "us-east-2"
      },
      "id": "uqsip6c2vm",
      "type": "objectStore",
      "category": "storage"
    }
  ]
}

The sample JSON below is returned when maskedSecret is set as true:

Use dark colors for code blocksCopy
{
  "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"
    },
    {
      "providerId": "s7my5d949q",
      "usage": "BACKUP",
      "name": "AWS S3",
      "connection": {
        "bucketName": "cloud-native-store",
        "credential": {
          "secret": {
            "secretKey": "{crypt}nawx4y2srvCw79gUkoE1WX3JWggzWjFp4jE5iH3KRExBKt+bJmqqFiAWs609vW68",
            "accessKey": "xxxxxxxxxxxxxxxxAZXS"
          },
          "type": "ACCESS-KEY"
        },
        "rootDir": "backups",
        "region": "us-east-2"
      },
      "id": "uqsip6c2vm",
      "type": "objectStore",
      "category": "storage"
    }
  ]
}