Replace a portal product version
Replace a portal product version
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal.
Body
application/json
Body
ReplacePortalProductVersionPayload
Payload to update a Portal Product Version
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
>= 0 items<= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Whether to notify developers who are affected by this change
Response
application/json
Response
A response containing a portal product version
PortalProductVersion
A Portal Product Version holds metadata that describes how a Product Version is configured for a specific portal.
It contains:
- Lifecyle and deprecation statuses
- Application registration settings like auto approve or whether application registration is enabled
- The Authentication Strategy (if present) that is enabled for Application Registration
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
One OfA list of authentication strategies
>= 0 items<= 1 items
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Authentication
Path Parameters
Body
Delete a portal product version
Delete a portal product version
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal.
Response
Response
No Content.
Authentication
Path Parameters
Publish Multiples Products
Publish or Unpublish multiple API Products to this developer portal.
Path Parameters
ID of the portal.
Body
application/json
Body
PublishAPIProductPayload,
Payload to publish/unpublish multiple API products
Response
Response
No Content
Authentication
Path Parameters
Body
Update Portal Audit Log Replay Job
Updates a job to re-send audit logs to an portal’s webhook.
Path Parameters
ID of the portal.
Body
application/json
Body
The request schema to replace a portal audit log replay job.
The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.
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
Response from fetching or updating an portal audit log replay job
The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.
Example:2017-07-21T17:32:28Z
The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.
Example:2017-07-21T17:32:28Z
Allowed values:unconfiguredacceptedpendingrunningcompletedfailed
Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.
Authentication
Path Parameters
Body
Get Portal Audit Log Replay Job
Returns the audit log replay job’s configuration and status.
Path Parameters
ID of the portal.
Response
application/json
Response
Response from fetching or updating an portal audit log replay job
The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.
Example:2017-07-21T17:32:28Z
The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.
Example:2017-07-21T17:32:28Z
Allowed values:unconfiguredacceptedpendingrunningcompletedfailed
Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.