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
}

Fields

DeployedApi.id ● ID! non-null scalar miscellaneous

DeployedApi.component ● Component! non-null object platform

The component associated with the deployed API.

DeployedApi.metadata ● DeployedApiComponentMetadata! non-null object platform

The metadata associated with the deployed API.

DeployedApi.authSource ● AuthSource interface platform

Authentication source used to secure this API deployment.

DeployedApi.environment ● Environment! non-null object event-streams-query

The environment on which the API is deployed.

DeployedApi.endpoints ● [DeployedApiEndpoint!] list object platform

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

DeployedApi.keylessPlan ● DeployedApiPlan object platform

The Keyless Plan associated with the deployed API.

DeployedApi.plans ● [DeployedApiPlan!] list object platform

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

DeployedApi.executionSettings ● DeployedApiExecutionSettings object platform

The run settings associated with the deployed API.

DeployedApi.requiredRoles ● [AuthSourceRole!] list object platform

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 that will be applied by the gateway to the API execution.

DeployedApi.subscriptions ● [DeployedApiSubscription!] list object platform

Subscriptions for the API

DeployedApi.version ● String scalar miscellaneous

Version identifier for this API deployment.

DeployedApi.documentation ● DeployedApiDocumentation object platform

Documentation and specification details for the API.

DeployedApi.testStatus ● DeployedApiTestStatus enum platform

Specifies the test status

DeployedApi.cors ● DeployedApiCors object platform

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

DeployedApi.certificateAuthentication ● DeployedApiCertificateAuthentication object platform

certificate authentication settings for the API

DeployedApi.customPolicyPathMode ● CustomPolicyPathMode enum platform

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

Returned By

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 ●  DeployedApiSubscription object ●  DeployedApiTestExecution object

Implemented By

_Entity union