REST API for the Administration Service in Oracle API Platform Cloud Service

All REST Endpoints

Artifacts

The operations from the Artifacts category.

Get all gateway artifacts: Method: get
Path: /apiplatform/administration/v1/artifacts
Get gateway artifacts of a specified name: Method: get
Path: /apiplatform/administration/v1/artifacts/{name}
Get gateway artifacts of a specified name and type: Method: get
Path: /apiplatform/administration/v1/artifacts/{name}/types/{type}
Get gateway artifacts of a specified name, version and type: Method: get
Path: /apiplatform/administration/v1/artifacts/{name}/types/{type}/versions/{version}
Upload a custom gateway artifact: Method: post
Path: /apiplatform/administration/v1/artifacts

Policies

The operations from the Policies category.

Create a new custom policy: Method: post
Path: /apiplatform/administration/v1/policies
Get all policies: Method: get
Path: /apiplatform/administration/v1/policies
Get policies of a specified type: Method: get
Path: /apiplatform/administration/v1/policies/{type}
Get policies of a specified version and type: Method: get
Path: /apiplatform/administration/v1/policies/{type}/versions/{version}

Preferences/Platform

Get and update platform preferences.

Get platform preferences: Method: get
Path: /apiplatform/administration/v1/preferences/platform
This API has been deprecated, instead use PATCH operation to update platform preferences: Method: put
Path: /apiplatform/administration/v1/preferences/platform
Update platform preferences: Method: patch
Path: /apiplatform/administration/v1/preferences/platform

Preferences/User

Get and update user preferences.

Get the collection of saved searches for the for the specified type: Method: get
Path: /apiplatform/administration/v1/preferences/user/searches/{type}
Get the name of the default search for the specified type: Method: get
Path: /apiplatform/administration/v1/preferences/user/searches/{type}/default
Get user preferences: Method: get
Path: /apiplatform/administration/v1/preferences/user
Replace the collection of saved searches for the specified type: Method: put
Path: /apiplatform/administration/v1/preferences/user/searches/{type}
This API has been deprecated and will be removed in a future release. Use PATCH operation to update user preferences: Method: put
Path: /apiplatform/administration/v1/preferences/user
Update the default search name for the specified search type: Method: put
Path: /apiplatform/administration/v1/preferences/user/searches/{type}/default
Update user preferences: Method: patch
Path: /apiplatform/administration/v1/preferences/user

Preferences/Utilities

Get supported time zones.

Get supported time zones: Method: get
Path: /apiplatform/administration/v1/preferences/timezones

Roles

Get details about roles.

Get all roles: Method: get
Path: /apiplatform/administration/v1/roles
Get role details: Method: get
Path: /apiplatform/administration/v1/roles/{roleId}

Roles/Grants

Get details about the grants that can be issued for a role.

Get grants that can be issued to role members: Method: get
Path: /apiplatform/administration/v1/roles/{roleId}/grants

Roles/Members

Get role assignments and grant and remove roles from users and groups.

Get users and groups assigned a role: Method: get
Path: /apiplatform/administration/v1/roles/{roleId}/members

Version

Get details about the version.

Get APICS version information: Method: get
Path: /apiplatform/administration/v1/version