Get enterprise settings

GET /enterprises/{enterprise_identifier}

Get the enterprise settings for the specified enterprise ID

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - Successful response. Your permissions determine what you can see

id

string

Enterprise identification

_rev

string

Cloudant revision

account_filters

Filters

Filters for account and catalog filters

account_groups

object

Map of account group ids to AccountGroup objects

region_filters

array

401 - Unauthorized

403 - No Permissions

Update enterprise settings

PUT /enterprises/{enterprise_identifier}

Update the settings for an enterprise

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Enterprise

id

string

Enterprise identification

_rev

string

Cloudant revision

account_filters

Filters

Filters for account and catalog filters

include_all

boolean

-> true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.

object

Filter against offering properties

id_filters

object

Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.

account_groups

object

Map of account group ids to AccountGroup objects

keys

object

Filters for an Account Group

region_filters

array

Response

200 - Successful update. Your permissions determine if can update or not.

401 - Unauthorized

403 - No Permissions

Get enterprise audit logs

GET /enterprises/{enterprise_identifier}/audits

Get the audit logs associated with an enterprise.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

enterprise_identifier

Required *

string

Enterprise ID

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get an enterprise audit log entry

GET /enterprises/{enterprise_identifier}/audits/{auditlog_identifier}

Get the full audit log entry associated with an enterprise.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

enterprise_identifier

Required *

string

Enterprise ID

auditlog_identifier

Required *

string

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

Get enterprise audit log

GET /enterprises/{enterprise_identifier}/audit

Get the audit log associated with an enterprise.

Auditing

The bookmark of the first resource in this page of search results. Omit for first entry.

limit

integer

The maximum number of resources returned in each page of search results.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

list

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get catalog account settings

GET /catalogaccount

Get the account level settings for the account for private catalog

Auditing

Calling this method generates the following auditing event.

Request

Response

List of terraform engines configured for this account

401 - Unauthorized

403 - No Permissions

Update account settings

PUT /catalogaccount

Update the account level settings for the account for private catalog

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Account

id

string

Account identification

_rev

string

Cloudant revision

hide_IBM_cloud_catalog

boolean

Hide the public catalog in this account

account_filters

Filters

Filters for account and catalog filters

include_all

boolean

object

Filter against offering properties

id_filters

object

Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.

region_filter

string

Region filter string

terraform_engines

array

List of terraform engines configured for this account

Response

List of terraform engines configured for this account

401 - Unauthorized

403 - No Permissions

Get catalog account audit logs

GET /catalogaccount/audits

Get the audit logs associated with a catalog account.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get a catalog account audit log entry

GET /catalogaccount/audits/{auditlog_identifier}

Get the full audit log entry associated with a catalog account.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

auditlog_identifier

Required *

string

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

Get catalog account filters

GET /catalogaccount/filters

Get the accumulated filters of the account and of the catalogs you have access to.

Request

Path Parameters

Query Parameters

catalog

string

catalog id. Narrow down filters to the account and just the one catalog.

Response

200 - Successful response. Your permissions determine what you can see

hide_IBM_cloud_catalog

boolean

Hide the public catalog in this account

account_filters

array

Filters for accounts (at this time this will always be just one item array)

array

The filters for all of the accessible catalogs.

region_filters

array

filtered_regions

array

filter_regions

boolean

401 - Unauthorized

403 - No Permissions

Get catalog account audit log

GET /catalogaccount/audit

Get the audit log associated with a catalog account.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

id

string

Log identification.

Response

200 - Successful response. Your permissions determine what you can see

A URL for retrieving the next page of search results.

list

array

A list of audit records

401 - Unauthorized

403 - No Permissions

GET /shareapproval/{object_type}/accessv2

Get the share approval access list associated with the specified object type

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

Response

200 - Successful response

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

resources

array

A list of access records

400 - Bad request

401 - Unauthorized

403 - No Permissions

DELETE /shareapproval/{object_type}/access

Delete share approval accesses associated with the specified object type

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to delete. An entry with star["*"] will remove all accesses

Response

200 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

POST /shareapproval/{object_type}/access

Add one or more accesses to the share approval access list for a specific object type.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to add.

Response

201 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

GET /shareapproval/{object_type}/accessv2/source/{approval_state_identifier}

Get the share approval access list associated with the specified object type in a certain approval state for requesting accounts

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

enterprise_id

string

Execute the request in the context of an enterprise or enterpise account group ID. Use '-ent-enterpriseid' for an enterprise and '-entgrp-enterprisegroupid for an enterprise group

Response

200 - Successful response

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

resources

array

A list of access records

400 - Bad request

401 - Unauthorized

403 - No Permissions

POST /shareapproval/{object_type}/access/source/{approval_state_identifier}

Update one or more access approval states from the share approval access list for a specific object type for requesting accounts.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to update to the specified approval state.

Path Parameters

Query Parameters

enterprise_id

string

Execute the request in the context of an enterprise or enterpise account group ID. Use '-ent-enterpriseid' for an enterprise and '-entgrp-enterprisegroupid for an enterprise group

Response

201 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get list of catalogs

GET /catalogs

Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.

Auditing

Calling this method generates the following auditing event.

Request

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Create a catalog

POST /catalogs

Create a catalog for a given account

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

Account that owns catalog

Filters

Filters for account and catalog filters

kind

string

Kind of catalog. Supported kinds are offering and vpe

metadata

object

Catalog specific metadata

target_account_contexts

array

List of target accounts contexts on this catalog

401 - Unauthorized

403 - No Permissions

Get catalog

GET /catalogs/{catalog_identifier}

Get a catalog. This can also be used by an unauthenticated user to get the public catalog.

Auditing

Calling this method generates the following auditing event.

Request

Response

Account that owns catalog

Filters

Filters for account and catalog filters

kind

string

Kind of catalog. Supported kinds are offering and vpe

metadata

object

Catalog specific metadata

target_account_contexts

array

List of target accounts contexts on this catalog

401 - Unauthorized

403 - No Permissions

404 - No such catalog id

Update catalog

PUT /catalogs/{catalog_identifier}

Update a catalog

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

Account that owns catalog

Filters

Filters for account and catalog filters

kind

string

Kind of catalog. Supported kinds are offering and vpe

metadata

object

Catalog specific metadata

target_account_contexts

array

List of target accounts contexts on this catalog

401 - Unauthorized

403 - No Permissions

404 - No such catalog id

Delete catalog

DELETE /catalogs/{catalog_identifier}

Delete a catalog

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Get catalog audit logs

GET /catalogs/{catalog_identifier}/audits

Get the audit logs associated with a catalog.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get a catalog audit log entry

GET /catalogs/{catalog_identifier}/audits/{auditlog_identifier}

Get the full audit log entry associated with a catalog.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

auditlog_identifier

Required *

string

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

Get catalog audit log

GET /catalogs/{catalog_identifier}/audit

Get the audit log associated with a catalog.

Auditing

The bookmark of the first resource in this page of search results. Omit for first entry.

limit

integer

The maximum number of resources returned in each page of search results.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

list

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get consumption offerings

GET /offerings

Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

digest

boolean

true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

catalog

string

catalog id. Narrow search down to just a particular catalog. It will apply the catalog's public filters to the public catalog offerings on the result.

select

string

What should be selected. Default is 'all' which will return both public and private offerings. 'public' returns only the public offerings and 'private' returns only the private offerings.

includeHidden

boolean

true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.

limit

integer

number or results to return

offset

integer

number of results to skip before returning values

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Get list of offerings

GET /catalogs/{catalog_identifier}/offerings

Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

digest

boolean

true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

limit

integer

The maximum number of results to return

offset

integer

The number of results to skip before returning values

name

string

Only return results that contain the specified string

sort

string

The field on which the output is sorted. Sorts by default by label property. Available fields are name, label, created, and updated. By adding - (i.e. -label) in front of the query string, you can specify descending order. Default is ascending order.

includeHidden

boolean

true - include offerings which have been marked as hidden. The default is true. To not return hidden offerings false must be explicitly set

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Create offering

POST /catalogs/{catalog_identifier}/offerings

Create an offering

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Import offering version

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/version

Import new version to an offering

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

zipurl

string

URL path to zip location. If not specified, must provide content in the body of this call.

targetVersion

string

The semver value for this new version, if not found in the zip url package content

includeConfig

boolean

Add all possible configuration values to this version when importing

isVSI

boolean

Indicates that the current terraform template is used to install a virtual server image

repotype

string

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Import offering

POST /catalogs/{catalog_identifier}/import/offerings

Import a new offering

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Reload offering

PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/reload

Reload an existing version in offering from a tgz

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

targetVersion

Required *

string

The semver value for this new version

zipurl

string

URL path to zip location. If not specified, must provide content in this post body.

repoType

string

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Update offering

PUT /catalogs/{catalog_identifier}/offerings/{offering_id}

Update an offering

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Update offering

PATCH /catalogs/{catalog_identifier}/offerings/{offering_id}

Update an offering using a JSONPatch document as defined by RFC 6902.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Delete offering

DELETE /catalogs/{catalog_identifier}/offerings/{offering_id}

Delete an offering

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

Query Parameters

Response

200 - Offering was deleted successfully

401 - Unauthorized

403 - No Permissions

404 - No such catalogg

Get offering statistics

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/stats

Get the usage statistics for the specified offering.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

Query Parameters

Response

200 - Successful response. Your permissions determine what you can see

target_type

string

What these statistics are for (i.e. Offering, Object, Plan, etc)

id

string

Target ID

stats

array

Statistics array. Sorted on YearWeekIdx. This array may have at most 52 entries, but may contain fewer if there are no statistics in a particular week

totals

WeeklyMetricBucket

Total statistics for the specified target

401 - Unauthorized

403 - No Permissions

Get offering audit logs

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/audits

Get the audit logs associated with an offering.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get an offering audit log entry

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/audits/{auditlog_identifier}

Get the full audit log entry associated with an offering.

Auditing

Calling this method generates the following auditing event.

Request

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

Set offering publish approval settings

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/publish/{approval_type}/{approved}

Approve or disapprove the offering to be allowed to publish to a particular public catalog based on the approval type. Approvers should use the catalog and offering id from the public catalog since they wouldn't have access to the private offering.

Auditing

Calling this method generates the following auditing event.

Request

Type of approval.

`pc_managed` - Partner Center is managing this offering
`ibm_module_repo` - Offering is from an approved repository can be published into the module registry.
`ibm_community` - Offering is from an approved repository can be published into the Community registry.
`publish_approved` - Publishing approved, offering owners can now set who sees the offering in public catalog
`approval_required` - Offering will be removed from public catalog when this flag is set to true, regardless of the approval and visibility settings.

approved

Required *

string

Approve (true) or disapprove (false)

Query Parameters

portal_record

string

Partner Center identifier for this offering

portal_url

string

Partner Center url for this offering

Response

Denotes whether approvals have changed

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Allows offering to be deprecated

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/deprecate/{setting}

Approve or disapprove the offering to be deprecated.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

Allows offering to be shared

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/share

Set the share options on an offering.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

200 - Successful response. Your permissions determine what you can see

ibm

boolean

Visible to IBM employees

public

boolean

Visible to everyone in the public catalog

enabled

boolean

Visible to access list

400 - Bad request

401 - Unauthorized

403 - No Permissions

Check for account ID in offering access list

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/access/{access_identifier}

Determine if an account ID is in an offering's access list

Auditing

Calling this method generates the following auditing event.

Request

Response

Approval state for access. If this field is an empty string, then it means that it's approved

visible_states

array

List of additional version states that this account can see. The default visible states are consumable and prerelease.

400 - Bad request

401 - Unauthorized

403 - No Permissions

404 - The specified account ID was not found in the offering's access list.

Update the access list entry for a specific account

PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/access/{access_identifier}

Update an access list entry for a specific account

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

Approval state for access. If this field is an empty string, then it means that it's approved

visible_states

array

List of additional version states that this account can see. The default visible states are consumable and prerelease.

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering/access list entry

Get offering access list

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/accessv2

Get the access list associated with the specified offering

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

Response

200 - Successful response

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

resources

array

A list of access records

400 - Bad request

401 - Unauthorized

403 - No Permissions

Delete accesses from offering access list

DELETE /catalogs/{catalog_identifier}/offerings/{offering_id}/access

Delete all or a set of accesses from an offering's access list.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to delete. An entry with star["*"] will remove all accesses

Response

200 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

Add accesses to offering access list

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/access

Add one or more accesses to the specified offering's access list.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to add.

Response

201 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get version updates

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/updates

Get available updates for the specified version

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

kind

Required *

string

The install type of the version that was installed

Response

200 - Version Descriptors, sorted newest first

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get version change notices

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/changeNotices

Get change notices for the specified version

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

kind

Required *

string

The kind of offering (e.g, helm, ova, terraform ...)

target

string

The target kind of the currently installed version (e.g. iks, roks, etc)

version

string

optionaly provide an existing version to check updates for if one is not given, all version will be returned.

flavor

string

The programmatic flavor name of the version that was installed

versions

string

optionaly specify if change notices should be returned for all versions of this kind and flavor, or for all versions that are newer than the specified version, including the specified version

Response

200 - Change notices, sorted newest first

has_breaking

boolean

Set to true if any of the included change notices contain a breaking change

has_new

boolean

Set to true if any of the included change notices contain a new change

has_update

boolean

Set to true if any of the included change notices contain an update

change_notices

array

All changes notices for the requested versions

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get offering source

GET /offering/source

Get an offering's source. This request requires authorization for private offerings.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

catalogID

string

Catalog ID. If not specified, this value will default to the public catalog.

name

string

Offering name. An offering name or ID must be specified.

id

string

Offering id. An offering name or ID must be specified.

kind

string

The kind of offering (e.g. helm, ova, terraform...)

version

Required *

string

The version being requested

channel

string

The channel value of the specified version

flavor

string

The programmatic flavor name of the specified version

asIs

boolean

If false (the default), the root folder from the original onboarded tgz file is removed. If true, the root folder is returned.

installType

string

The install type of the specified version.

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

404 - No such offering

Get offering source

GET /offering/source/archive

Get an offering's source. This request requires authorization for private offerings. Note that the URL can include an additional 'working directory' value (i.e. /offering/source/archive//solutions/standard), which allows this single URL to be used in a Terraform module statement as well.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

catalogID

string

Catalog ID. If not specified, this value will default to the public catalog.

name

string

Offering name. An offering name or ID must be specified.

id

string

Offering id. An offering name or ID must be specified.

kind

string

The kind of offering (e.g. helm, ova, terraform...)

version

Required *

string

The version being requested

channel

string

The channel value of the specified version

flavor

string

The programmatic flavor name of the specified version

asIs

boolean

If false (the default), the root folder from the original onboarded tgz file is removed. If true, the root folder is returned.

installType

string

The install type of the specified version.

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

404 - No such offering

Get offering source URL

GET /offering/source/url/{key_identifier}

Get an offering's private source image.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

catalogID

string

Catalog ID. If not specified, this value will default to the public catalog.

name

string

Offering name. An offering name or ID must be specified.

id

string

Offering id. An offering name or ID must be specified.

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

404 - No such offering

Get offering audit log

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/audit

Get the audit log associated with an offering.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

Query Parameters

id

string

Log identification.

Response

200 - Successful response. Your permissions determine what you can see

A URL for retrieving the next page of search results.

list

array

A list of audit records

401 - Unauthorized

403 - No Permissions

List objects across catalogs

GET /objects

List the available objects from both public and private catalogs. These copies cannot be used for updating. They are not complete and only return what is visible to the caller.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

kind

string

The kind of the object. It will default to "vpe"

query

Required *

string

Lucene query string

limit

integer

The maximum number of results to return

offset

integer

The number of results to skip before returning values

collapse

boolean

When true, hide private objects that correspond to public or IBM published objects

digest

boolean

Display a digests of search results, has default value of true

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Get versions

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/kinds/{kind_id}/versions

Get the versions of the specified kind in the specified offering. This can be used by an unauthenticated user for publicly available offerings.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

digest

boolean

Return the digest format of the specified offering. Default is false.

catalog

boolean

Return consumable versions. Default is false.

start

string

Start token for a query

limit

integer

number or results to return in the query

Response

200 - Successful Result

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

versions

array

A list of versions

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

List objects within a catalog

GET /catalogs/{catalog_identifier}/objects

List the available objects within the specified catalog.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

limit

integer

The number of results to return

offset

integer

The number of results to skip before returning values

name

string

Only return results that contain the specified string

sort

string

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Create catalog object

POST /catalogs/{catalog_identifier}/objects

Create an object with a specific catalog

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

The name of the catalog

data

object

Map of data values for this object

401 - Unauthorized

403 - No Permissions

Get catalog object

GET /catalogs/{catalog_identifier}/objects/{object_identifier}

Get the specified object from within the specified catalog

Auditing

Calling this method generates the following auditing event.

Request

Response

The name of the catalog

data

object

Map of data values for this object

401 - Unauthorized

403 - No Permissions

404 - No such catalog/object

Update catalog object

PUT /catalogs/{catalog_identifier}/objects/{object_identifier}

Update an object within a specific catalog

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

The name of the catalog

data

object

Map of data values for this object

401 - Unauthorized

403 - No Permissions

404 - No such catalog/object

Delete catalog object

DELETE /catalogs/{catalog_identifier}/objects/{object_identifier}

Delete a specific object within a specific catalog

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - Catalog object was deleted successfully

401 - Unauthorized

403 - No Permissions

404 - No such catalog

Get object audit logs

GET /catalogs/{catalog_identifier}/objects/{object_identifier}/audits

Get the audit logs associated with an object.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

object_identifier

Required *

string

Object identifier

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get an object audit log entry

GET /catalogs/{catalog_identifier}/objects/{object_identifier}/audits/{auditlog_identifier}

Get the full audit log entry associated with an object.

Auditing

Calling this method generates the following auditing event.

Request

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

POST /catalogs/{catalog_identifier}/objects/{object_identifier}/consume-publish

Set the object as consumable in order to use the object sharing permissions.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

object_identifier

Required *

string

Object identifier

Query Parameters

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

Allows object to be shared

POST /catalogs/{catalog_identifier}/objects/{object_identifier}/share

Set the share options on an object.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

200 - Successful response. Your permissions determine what you can see

ibm

boolean

Visible to IBM employees

public

boolean

Visible to everyone in the public catalog

enabled

boolean

Visible to access list

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get object access list

GET /catalogs/{catalog_identifier}/objects/{object_identifier}/accessv2

Get the access list associated with the specified object

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

Response

200 - Successful response

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

resources

array

A list of access records

400 - Bad request

401 - Unauthorized

403 - No Permissions

Check for account ID in object access list

GET /catalogs/{catalog_identifier}/objects/{object_identifier}/access/{access_identifier}

Determine if an account ID is in an object's access list

Auditing

Calling this method generates the following auditing event.

Request

Response

Approval state for access. If this field is an empty string, then it means that it's approved

visible_states

array

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

400 - Bad request

401 - Unauthorized

403 - No Permissions

Delete accesses from object access list

DELETE /catalogs/{catalog_identifier}/objects/{object_identifier}/access

Delete all or a set of accesses from an object's access list.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to delete. An entry with star["*"] will remove all accesses

Response

200 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

Add accesses to object access list

POST /catalogs/{catalog_identifier}/objects/{object_identifier}/access

Add one or more accesses to the specified object's access list.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

A list of accesses to add.

Response

201 - Successful response, still need to look for errors for specific accesses

errors

object

in the case of error on an account add/remove - account: error

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get catalog object audit log

GET /catalogs/{catalog_identifier}/objects/{object_identifier}/audit

Get the audit log associated with a specific catalog object.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

object_identifier

Required *

string

Object identifier

Query Parameters

id

string

Log identification.

Response

200 - Successful response. Your permissions determine what you can see

A URL for retrieving the next page of search results.

list

array

A list of audit records

Get version's container images

GET /versions/{version_loc_id}/containerImages

Get the list of container images associated with the specified version. The "image_manifest_url" property of the version should be the URL for the image manifest, and the operation will return that content

Request

Response

200 - Successful response. A list of images

description

string

Image manifest description

images

array

401 - Unauthorized

403 - No Permissions

Create working copy of version

POST /versions/{version_loc_id}/workingcopy

Create a working copy of the specified version

Auditing

Calling this method generates the following auditing event.

Request

Response

A list of plan ids that are applicable for this version

stack

object

Optional. Stack definition that was used to create this version

minimum_compatible_version

string

The lowest version (semver) that can upgrade to this version

400 - Bad request

401 - Unauthorized

403 - No Permissions

409 - Working Copy already exists

Copy values from a previous version

POST /versions/{version_loc_id}/copy/{type}/{version_loc_id_to_copy_from}

Copy values from a specified previous version

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - Values copied successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

404 - Catalog not found from specified version locator.

Validates deployment input variables

POST /versions/{version_loc_id}/validateInputs

Validates deployment input variables

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

200 - Input validation preformed successfully

message

string

Failure message

code

string

Response code

global_transaction_id

string

Transaction ID

errors

array

Transaction ID

400 - Bad request

401 - Unauthorized

403 - No Permissions

404 - Catalog not found from specified version locator.

Get offering/kind/version 'branch'

GET /versions/{version_loc_id}

Get the Offering/Kind/Version 'branch' for the specified locator ID

Auditing

Calling this method generates the following auditing event.

Request

Response

Request

Request Body

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Update a version

PATCH /versions/{version_loc_id}

Update a version using a JSONPatch document as defined by RFC 6902. Note that the path must always reference '/kinds/0/versions/0/...'

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

Response

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Delete version

DELETE /versions/{version_loc_id}

Delete the specified version. If the version is an active version with a working copy, the working copy will be deleted as well.

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - Version deleted successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get offering/kind/version 'dependencies'

GET /versions/{version_loc_id}/dependencies

Get the latest version of all offerings/variations that depends on this version locator

Request

Response

200 - Successful response. Your permissions determine what you can see

start

string

The start token used for this response

limit

integer

The limit that was applied to this response. It may be smaller than in the request because that was too large

total_count

integer

The total count of resources in the system that matches the request

resource_count

integer

The number of resources returned in this response

version

object

first

PaginationTokenLink

Link response on a token paginated query

PaginationTokenLink

Link response on a token paginated query

PaginationTokenLink

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

Deprecate version immediately - use /archive instead

POST /versions/{version_loc_id}/deprecate

Deprecate the specified version

Auditing

Calling this method generates the following auditing event.

Request

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

List a repository's entries

GET /repo/{type}/entries

List the available entries from a given repository

Request

Path Parameters

Query Parameters

repourl

Required *

string

The URL for the repository's root (e.g https://kubernetes-charts-incubator.storage.googleapis.com)

Response

200 - Successful response.

chart

object

A chart entry in the repo. This response will contain many chart names.

Get repository contents

GET /repo/{type}

Get the contents of a given repo

Request

Path Parameters

Query Parameters

charturl

Required *

string

The URL for the repository's chart zip file (e.g https://registry.bluemix.net/helm/ibm-charts/charts/ibm-redis-ha-dev-1.0.0.tgz)

Response

200 - Successful response.

chart

object

The name of the requested chart, or the name of a nested chart within the requested chart.

Get kubernetes cluster

GET /deploy/kubernetes/clusters/{cluster_id}

Get the contents of the specified kubernetes cluster

Request

Path Parameters

Query Parameters

region

Required *

string

Region of the cluster

Response

Cluster status

401 - Unauthorized

403 - No Permissions

404 - No such cluster

Get cluster namespaces

GET /deploy/kubernetes/clusters/{cluster_id}/namespaces

Get the namespaces associated with the specified kubernetes cluster

Request

Path Parameters

Query Parameters

region

Required *

string

Cluster region

limit

integer

The maximum number of results to return

offset

integer

The number of results to skip before returning values

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

401 - Unauthorized

403 - No Permissions

404 - No such cluster

Deploy operators

POST /deploy/kubernetes/olm/operator

Deploy operators on a kubernetes cluster

Request

Request Body

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

List operators

GET /deploy/kubernetes/olm/operator

List the operators from a kubernetes cluster

Request

Path Parameters

A dotted value of `catalogID`.`versionID`

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Update operators

PUT /deploy/kubernetes/olm/operator

Update the operators on a kubernetes cluster

Request

Request Body

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Delete operators

DELETE /deploy/kubernetes/olm/operator

Delete operators from a kubernetes cluster

Request

Path Parameters

A dotted value of `catalogID`.`versionID`

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Install version

POST /versions/{version_loc_id}/install

Create an install for the specified version

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Pre-install version

POST /versions/{version_loc_id}/preinstall

Create a pre-install for the specified version

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get version pre-install status

GET /versions/{version_loc_id}/preinstall

Get the pre-install status for the specified version

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

cluster_id

string

ID of the cluster

region

string

Cluster region

namespace

string

Required if the version's pre-install scope is `namespace`

Response

200 - Preinstall status

metadata

object

Installation status metadata

release

object

Release information

content_mgmt

object

Content management information

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Validate offering

POST /versions/{version_loc_id}/validation/install

Validate the offering associated with the specified version

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get offering install status

GET /versions/{version_loc_id}/validation/install

Returns the install status for the specified offering version

Auditing

Calling this method generates the following auditing event.

Request

Response

Any message needing to be conveyed as part of the validation job

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get schematics workspaces

GET /versions/{version_loc_id}/workspaces

Returns the schematics workspaces for the specified offering version

Request

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering/kind/version

Get resource groups

GET /deploy/schematics/resourcegroups

Returns all active resource groups in the current account, where the current user has permission to create schematics workspaces.

Request

Response

A URL for retrieving the last page of search results.

string

A URL for retrieving the previous page of search results.

string

A URL for retrieving the next page of search results.

resources

array

Resulting Resource Group objects

401 - Unauthorized

403 - No Permissions

Get license providers

GET /license/license_providers

Get license providers

Request

Response

200 - Successful response.

total_results

integer

The GC ID of the specific offering version.

state

string

The state of the license entitlement. eg. usually 'active', or if it's been deleted will show as 'removed'.

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting Entitlement objects

Create license entitlement

POST /license/entitlements

License provider ID

license_product_id

string

License product ID

Path Parameters

401 - Unauthorized

403 - No Permissions

Get license entitlements for license product ID

GET /license/entitlements/productID/{license_product_id}

Get the license entitlements for a specific license product ID bound to an account

Request

Path Parameters

Query Parameters

account_id

string

The account ID to query for the entitlement. Default is the account from the user's token.

version_id

string

The GC ID of the specific offering version.

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting Entitlement objects

Delete license entitlement

DELETE /license/entitlements/{entitlement_id}

Delete a license entitlement that is bound to an account. Note that BSS will mark the entitlement field "state": "removed".

Request

Path Parameters

Query Parameters

account_id

string

The account ID to query for the entitlement. Default is the account from the user's token.

Response

200 - Successful response.

401 - Unauthorized

403 - No Permissions

Get licenses

GET /license/licenses

Retrieve available licenses from supported license subsystems. This is used to get the list of available licenses that the user has

Request

Path Parameters

Query Parameters

license_provider_id

Required *

string

ID of the license provider, ie. retrieved from GET license_providers

account_id

string

If not specified the token's account will be used

name

string

License name

license_type

string

Type of license, if not specified, default is ibm-ppa

license_product_id

string

The license product ID. If from PPA (Passport Advantage) this is the product Part number, eg. D1YGZLL

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting License objects

Create an offering resource instance

POST /instances/offerings

Provision a new offering in a given account, and return its resource instance

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

Response

Entitlement information for licenses provisioned from plan

401 - Unauthorized

403 - No Permissions

List offering instances

GET /instances/offerings

List the available offering instances for the specified account and offering.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

offeringID

Required *

string

Return all offering instances that were created from the specified offering id.

start

string

Start token for a query

limit

integer

number or results to return in the query

Response

200 - Successful response. Your permissions determine what you can see.

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

instances

array

A list of offering instance records

Get Offering Instance

GET /instances/offerings/{instance_identifier}

Get the resource associated with an installed offering instance.

Auditing

Calling this method generates the following auditing event.

Request

Response

Id of the schematics workspace, for offering instances provisioned through schematics

Calling this method generates the following auditing event.

Request

Request Body

Path Parameters

Query Parameters

Response

Id of the schematics workspace, for offering instances provisioned through schematics

Calling this method generates the following auditing event.

Request

Path Parameters

Query Parameters

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

404 - No such catalog

Get offering instance audit logs

GET /instances/offerings/{instance_identifier}/audits

Get the audit logs associated with an offering instance.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

instance_identifier

Required *

string

Version Instance identifier

Query Parameters

start

string

Start token for a query

limit

integer

number or results to return in the query

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

200 - Successful response. Your permissions determine what you can see

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

audits

array

A list of audit records

401 - Unauthorized

403 - No Permissions

Get an offering instance audit log entry

GET /instances/offerings/{instance_identifier}/audits/{auditlog_identifier}

Get the full audit log entry associated with an offering instance.

Auditing

Calling this method generates the following auditing event.

Request

Path Parameters

instance_identifier

Required *

string

Version Instance identifier

auditlog_identifier

Required *

string

Auditlog ID

Query Parameters

lookupnames

boolean

Auditlog Lookup Names - by default names are not returned in auditlog.

Response

Name of the delegate user who made the change

data

object

Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.

401 - Unauthorized

403 - No Permissions

Get offering/plan 'branch'

GET /plans/{plan_loc_id}

Get the Offering/Plan 'branch' for the specified locator ID

Auditing

Calling this method generates the following auditing event.

Request

Response

Request

Response

200 - Plan deleted successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

POST /plans/{plan_loc_id}/consume-publish

Set the plan as consumable in order to inherit the offering sharing permissions

Auditing

Calling this method generates the following auditing event.

Request

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

Sets plan to be deprecated in a certain time period

POST /plans/{plan_loc_id}/deprecate/{setting}

Set or cancel the plan to be deprecated.

Auditing

Calling this method generates the following auditing event.

Request

Request Body

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

Returns available locations based on supplied filter

POST /regions

Returns available locations based on supplied filter

Request

Response

Link response on a token paginated query

regions

array

Resulting objects

400 - Bad request

401 - Unauthorized

403 - No Permissions

Returns available locations based on filter set on the account and supplied filter

GET /regions

Returns available locations based on filter set on the account and supplied filter

Request

Response

Link response on a token paginated query

regions

array

Resulting objects

Get enterprise settings

Auditing

Request

Response

200 - Successful response. Your permissions determine what you can see

id

_rev

account_filters

account_groups

region_filters

401 - Unauthorized

403 - No Permissions

Update enterprise settings

Auditing

Request

Request Body

id

_rev

account_filters

include_all

category_filters

id_filters

account_groups

keys

region_filters

Response

200 - Successful update. Your permissions determine if can update or not.

401 - Unauthorized

403 - No Permissions

Get enterprise audit logs

Auditing

Request

Path Parameters

enterprise_identifier

Query Parameters

start

limit

lookupnames

Response

200 - Successful response. Your permissions determine what you can see

start

limit

total_count

resource_count

first

next

prev

last

audits

401 - Unauthorized

403 - No Permissions

Get an enterprise audit log entry

Auditing

Request

Path Parameters

enterprise_identifier

auditlog_identifier

Query Parameters

lookupnames

Response

200 - Successful response. Your permissions determine what you can see

id

_rev

created

change_type

target_type

target_id

who_email

who_delegate_email

message

gid

who_id

who_name

who_delegate_id

who_delegate_name

data

401 - Unauthorized

403 - No Permissions

Get enterprise audit log

Auditing