Update a portal product version

Update a portal product version

patch

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.

Body

application/json

UpdatePortalProductVersionPayload

Payload to update a Portal Product Version

* Additional properties are NOT allowed.
publish_statusstring

Publication status of the API product version on the portal

Allowed values:publishedunpublished

auth_strategy_idsarray[string](uuid)

Contains a unique identifier used for this resource.

>= 0 items<= 1 items

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

application_registration_enabledboolean

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationboolean

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedboolean

Whether the api product version on the portal is deprecated

notify_developersboolean

Whether to notify developers who are affected by this change

Response

application/json

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
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

product_version_idstring(uuid)required

Contains a unique identifier used for this resource.

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

auth_strategiesOne Of
array[object]required

A list of authentication strategies

>= 0 items<= 1 items

AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

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

Body

{ "auto_approve_registration": false }
 
application/json

Replace a portal product version

Replace a portal product version

put

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.

Body

application/json

ReplacePortalProductVersionPayload

Payload to update a Portal Product Version

* Additional properties are NOT allowed.
publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

auth_strategy_idsarray[string](uuid)required

Contains a unique identifier used for this resource.

>= 0 items<= 1 items

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

application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

notify_developersboolean

Whether to notify developers who are affected by this change

Response

application/json

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
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

product_version_idstring(uuid)required

Contains a unique identifier used for this resource.

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

auth_strategiesOne Of
array[object]required

A list of authentication strategies

>= 0 items<= 1 items

AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

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

Body

{ "auth_strategy_ids": [ "44f8380e-7798-4566-99e3-2edf2b57d289" ], "publish_status": "published", "application_registration_enabled": true, "auto_approve_registration": true, "deprecated": false }
 
application/json

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