Delete a portal product version

Delete a portal product version

delete

Path Parameters

productVersionIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portalIdstring(uuid)required

ID of the portal.

Response

No Content.

delete/portals/{portalId}/product-versions/{productVersionId}
 

Publish Multiples Products

Publish or Unpublish multiple API Products to this developer portal.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PublishAPIProductPayload,

Payload to publish/unpublish multiple API products

* Additional properties are NOT allowed.
api_productsobjectrequired

Response

No Content

post/portals/{portalId}/publish

Body

{ "api_products": { "820772b2-0c93-4a9c-8c5e-c2ccc63b3340": { "publish_status": "published" }, "9b4f4829-d540-4a3a-aefc-839852bdb3e8": { "publish_status": "unpublished" }, "edf3d192-3591-4b03-ac0b-69bad1fcba05": null } }
 

Update Portal Audit Log Replay Job

Updates a job to re-send audit logs to an portal’s webhook.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to replace a portal audit log replay job.

start_atstring(date-time)required

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

end_atstring(date-time)required

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

Response

application/json

Response from fetching or updating an portal audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

put/portals/{portalId}/audit-log-replay-job

Body

{ "start_at": "start_at", "end_at": "end_at" }
 
application/json

Get Portal Audit Log Replay Job

Returns the audit log replay job’s configuration and status.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Response from fetching or updating an portal audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

get/portals/{portalId}/audit-log-replay-job
 
application/json

Update Portal Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to modify an portal audit log webhook.

enabledboolean

Indicates if the data should be sent to the configured destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

Response

application/json

Portal audit log webhook response

enabledboolean

Indicates if the data should be sent to the configured audit log destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

patch/portals/{portalId}/audit-log-webhook

Body

{ "enabled": false }
 
application/json