Waiting for engine...
Skip to main content

deployedApiFrom

Returns DeployedApi from the specified environment and component.

Input Parameters:

  • environmentId: ID of the environment containing the deployed API.
  • componentId: ID of the component for the deployed API.

Response: DeployedApi object for the specific environment and component combination.

Example Request:

query {
deployedApiFrom(environmentId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>", componentId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
id,
version,
environment {
id,
name
},
component {
id,
name
},
metadata {
title,
version,
description
}
}
}

deployedApiFrom(
environmentId: ID!
componentId: ID!
): DeployedApi!

Arguments

deployedApiFrom.environmentId ● ID! non-null scalar miscellaneous

deployedApiFrom.componentId ● ID! non-null scalar miscellaneous

Type

DeployedApi object platform

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)

On this Page