Waiting for engine...
Skip to main content

devPortalUpdate

Updates a developer portal configuration including theme, environments, and display settings.

Input Parameters:

  • id: The ID of the API Gateway.
  • devPortalInput: Updated portal configuration including theme, environments, and display settings.

Response:

  • Returns DevPortalUpdateResult object with update status and any warnings.

Example Request:

mutation {
devPortalUpdate(
id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
devPortalInput: {
internalName: "BizCo Developer Portal",
theme: {
text: {
publishedName: "Business Company, Inc. Developer Portal",
welcomeMessage: "<p>Welcome to the developer portal for BizCo, where you can sample and subscribe to our APIs.</p>"
}
}
}
) {
status,
warnings {
entityIds,
errorCode,
message,
severity
}
}
}

devPortalUpdate(
id: ID!
devPortalInput: DevPortalInput!
): DevPortalUpdateResult!

Arguments

devPortalUpdate.id ● ID! non-null scalar miscellaneous

devPortalUpdate.devPortalInput ● DevPortalInput! non-null input platform

Type

DevPortalUpdateResult object platform

Result of a developer portal update operation including status and warnings.

On this Page