Waiting for engine...
Skip to main content

devPortalUpdateValidation

Validates DevPortal update input without performing the actual update.

Input Parameters:

  • id: The ID of the API Gateway.
  • devPortalInput: Portal configuration to validate including theme, environments, and settings.

Response: DevPortalUpdateResult object with validation status and any warnings or errors.

Example Request:

query {
devPortalUpdateValidation(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>", devPortalInput: {
internalName: "My Developer Portal",
environmentFilterEnabled: true,
theme: {
text: {
publishedName: "API Developer Portal",
welcomeMessage: "Welcome to our API ecosystem"
}
}
}) {
status,
warnings {
entityIds,
message,
severity
}
}
}

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

Arguments

devPortalUpdateValidation.id ● ID! non-null scalar miscellaneous

devPortalUpdateValidation.devPortalInput ● DevPortalInput! non-null input platform

Type

DevPortalUpdateResult object platform

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

On this Page