DeployedApi

Represents an API deployed to a specific environment and the various information associated with it (Component, ApiComponentMetadata, Environment, DeployedApiEndpoint, Keyless Plan, number of plans associated with Deployed Api, Execution Settings and required roles)

type DeployedApi {
  id: ID!
  component: Component!
  metadata: DeployedApiComponentMetadata!
  authSource: AuthSource
  environment: Environment!
  endpoints: [DeployedApiEndpoint!]
  keylessPlan: DeployedApiPlan
  plans: [DeployedApiPlan!]
  executionSettings: DeployedApiExecutionSettings
  requiredRoles: [AuthSourceRole!]
  customPolicies: [DeployedApiPolicy!]
  subscriptions: [DeployedApiSubscription!]
  version: String
  documentation: DeployedApiDocumentation
  testStatus: DeployedApiTestStatus
  cors: DeployedApiCors
  certificateAuthentication: DeployedApiCertificateAuthentication
  customPolicyPathMode: CustomPolicyPathMode
  outboundSslSettings: DeployedApiOutboundSslSettings
  policyTemplatesApplied: [DeployedApiPolicyTemplateApplied!]
  tracing: DeployedApiTracing
}

Fields

DeployedApi.id ● ID! non-null scalar miscellaneous {#id}

DeployedApi.component ● Component! non-null object platform {#component}

The component associated with the deployed API.

DeployedApi.metadata ● DeployedApiComponentMetadata! non-null object platform {#metadata}

The metadata associated with the deployed API.

DeployedApi.authSource ● AuthSource interface platform {#auth-source}

Authentication source used to secure this API deployment.

DeployedApi.environment ● Environment! non-null object platform {#environment}

The environment on which the API is deployed.

DeployedApi.endpoints ● [DeployedApiEndpoint!] list object platform {#endpoints}

A list detailing the types of endpoints and their base paths.

DeployedApi.keylessPlan ● DeployedApiPlan object platform {#keyless-plan}

The Keyless Plan associated with the deployed API.

DeployedApi.plans ● [DeployedApiPlan!] list object platform {#plans}

Available plans that define access controls and rate limits for this API.

DeployedApi.executionSettings ● DeployedApiExecutionSettings object platform {#execution-settings}

The run settings associated with the deployed API.

DeployedApi.requiredRoles ● [AuthSourceRole!] list object platform {#required-roles}

Only an authenticated user can perform API runs for this deployed API. The user must have at least one of the roles contained in this list.

DeployedApi.customPolicies ● [DeployedApiPolicy!] list object platform {#custom-policies}

Custom policies that will be applied by the gateway to the API execution.

DeployedApi.subscriptions ● [DeployedApiSubscription!] list object platform {#subscriptions}

Subscriptions for the API

DeployedApi.version ● String scalar miscellaneous {#version}

Version identifier for this API deployment.

DeployedApi.documentation ● DeployedApiDocumentation object platform {#documentation}

Documentation and specification details for the API.

DeployedApi.testStatus ● DeployedApiTestStatus enum platform {#test-status}

Specifies the test status

DeployedApi.cors ● DeployedApiCors object platform {#cors}

Cross-Origin Resource Sharing (CORS) configuration for the API.

DeployedApi.certificateAuthentication ● DeployedApiCertificateAuthentication object platform {#certificate-authentication}

certificate authentication settings for the API

DeployedApi.customPolicyPathMode ● CustomPolicyPathMode enum platform {#custom-policy-path-mode}

Custom policy path mode for a deployed API ( All Match, Best Match)

DeployedApi.outboundSslSettings ● DeployedApiOutboundSslSettings object platform {#outbound-ssl-settings}

Outbound (backend) SSL and mTLS settings for this API. Overrides the gateway-level settings for this API's backend calls.

DeployedApi.policyTemplatesApplied ● [DeployedApiPolicyTemplateApplied!] list object platform {#policy-templates-applied}

Policy templates applied to the API, grouped by path. The order of groups in this list has no effect on execution order — only the order of templates within each group matters.

DeployedApi.tracing ● DeployedApiTracing object platform {#tracing}

The OpenTelemetry tracing configuration for this deployed API

Returned By

apiPolicyTemplateApply mutation ●  deployedApi query ●  deployedApiCreate mutation ●  deployedApiFrom query ●  deployedApiPolicyBulkAdd mutation ●  deployedApis query ●  deployedApisTestPending query ●  deployedApiTestProgress mutation ●  deployedApiTestTrigger mutation ●  deployedApiUpdate mutation

Member Of

ApiLifecycle object ●  DeployedApiCallDetailData object ●  DeployedApiCallSummaryData object ●  DeployedApiMigration object ●  DeployedApiPolicyRule object ●  DeployedApiPolicyTemplateUsage object ●  DeployedApiSubscription object ●  DeployedApiTestExecution object

Implemented By

_Entity union