---
title: RestApis
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-restapis
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-restapis.html
section_ids:
  sec-amster-entity-restapis-global-ops: Global Operations
  sec-amster-entity-restapis-global-ops-getalltypes: getAllTypes
  sec-amster-entity-restapis-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-restapis-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-restapis-global-ops-read: read
  sec-amster-entity-restapis-global-ops-update: update
---

# RestApis

## Global Operations

Resource path:

```
/global-config/services/rest
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action RestApis --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action RestApis --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action RestApis --global --actionName nextdescendents
```

### read

**Usage**

```
am> read RestApis --global
```

### update

**Usage**

```
am> update RestApis --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaultProtocolVersion" : {
        "title" : "Default Protocol Version",
        "description" : "The API protocol version to use when a REST request does not specify an explicit version. Choose from:<br><br><ul><li><code>Oldest</code>. If an explicit version is not specified, the oldest protocol version is used.</li><li><code>Latest</code>. If an explicit version is not specified, the latest protocol version is used.</li><li><code>None</code>. If an explicit version is not specified, the request will not be handled and an error status is returned.</li></ul>",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "warningHeader" : {
        "title" : "Warning Header",
        "description" : "Whether to include a warning header in the response to a request which fails to include the <code>Accept-API-Version</code> header.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "descriptionsState" : {
        "title" : "API Descriptions",
        "description" : "Whether API Explorer and API Docs are enabled in OpenAM and how the documentation for them is generated. Dynamic generation includes descriptions from any custom services and authentication modules you may have added. Static generation only includes services and authentication modules that were present when OpenAM was built. Note that dynamic documentation generation may not work in some application containers.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "defaultVersion" : {
        "title" : "Default Resource Version",
        "description" : "The API resource version to use when the REST request does not specify an explicit version. Choose from:<br><br><ul><li><code>Latest</code>. If an explicit version is not specified, the latest resource version of an API is used.</li><li><code>Oldest</code>. If an explicit version is not specified, the oldest supported resource version of an API is used. Note that since APIs may be deprecated and fall out of support, the oldest <i>supported</i> version may not be the first version.</li><li><code>None</code>. If an explicit version is not specified, the request will not be handled and an error status is returned.</li></ul>",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "csrfFilterEnabled" : {
        "title" : "Enable CSRF Protection",
        "description" : "If enabled, all non-read/query requests will require the X-Requested-With header to be present.<br><br>Requiring a non-standard header ensures requests can only be made via methods (XHR) that have stricter same-origin policy protections in Web browsers, preventing Cross-Site Request Forgery (CSRF) attacks. Without this filter, cross-origin requests are prevented by the use of the application/json Content-Type header, which is less robust.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      }
    }
  }
  ```