Waiting for engine...
Skip to main content

apiLifecycle

Returns ApiLifecycle for specific API.

Input Parameters:

  • id: ID of the API component to get lifecycle information.
  • branchName: The name of the branch.

Response: ApiLifecycle object containing latest component information and all deployments across environments.

Example Request:

query {
apiLifecycle(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>", branchName: "main") {
latestComponent {
id,
name
},
latestComponentMetadata {
title,
version,
description
},
apiDeployments {
id,
version,
environment {
id,
name
}
}
}
}

apiLifecycle(
id: ID!
branchName: String
): ApiLifecycle!

Arguments

apiLifecycle.id ● ID! non-null scalar miscellaneous

apiLifecycle.branchName ● String scalar miscellaneous

Type

ApiLifecycle object platform

Represents the complete lifecycle information for an API, including its latest version and all deployments across environments.

On this Page