HTTP API Referencev1
Get a Blueprint Instance
Retrieve a blueprint deployment instance. This will return the current status of the deployment along with the current state of the blueprint instance.
AuthorizationBearer <token>
OAuth2/OIDC auth using JWT Bearer tokens. The token issuer will be configured independently for each Deploy Engine instance.
In: header
Path Parameters
idstring
The ID or unique name of a blueprint instance.
Header Parameters
Bluelink-Signature-V1?string
The Bluelink Signature v1 authentication mechanism can be used to authenticate requests to the Deploy Engine. See the Bluelink Signature v1 documentation for more information on how to use this authentication mechanism. This is not required if the request is authenticated using an OAuth2/OIDC-issued JWT or an API key.
Response Body
curl -X GET "https://{host}/{basePath}/v1/deployments/instances/16ef8989-af00-4a4a-8164-72493ceb1aa0" \ -H "Bluelink-Signature-V1: string"{
"id": "a97cf86f-2a5e-4614-984e-da480a0daa7a",
"name": "my-blueprint-instance",
"status": 2,
"lastStatusUpdateTimestamp": 1678901234,
"lastDeployedTimestamp": 1678901234,
"lastDeployAttemptTimestamp": 1678901234,
"resourceIds": {
"my-resource": "60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55"
},
"resources": {
"60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55": {
"id": "60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55",
"name": "my-resource",
"type": "aws/lambda/function",
"instanceId": "a97cf86f-2a5e-4614-984e-da480a0daa7a",
"status": 2,
"preciseStatus": 3,
"lastStatusUpdateTimestamp": 1678901234,
"lastDeployedTimestamp": 1678901234,
"lastDeployAttemptTimestamp": 1678901234,
"specData": {
"functionName": "my-lambda-function",
"handler": "index.handler",
"runtime": "nodejs20.x"
},
"metadata": {
"displayName": "My Lambda Function",
"annotations": {
"processing": true
},
"labels": {
"processing": true
},
"custom": {
"my-custom-metadata": "my-custom-metadata-value"
}
},
"dependsOnResources": [
"my-other-resource"
],
"dependsOnChildren": [
"my-other-child-blueprint"
],
"failureReasons": [
"The resource could not be created because the IAM role does not exist."
],
"drifted": true,
"lastDriftDetectedTimestamp": 1678901234,
"durations": {
"configCompleteDuration": 10000,
"totalDuration": 20000,
"attemptDurations": [
20000
]
}
}
},
"links": {
"vpc::subnet": {
"id": "60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55",
"name": "vpc::subnet",
"instanceId": "a97cf86f-2a5e-4614-984e-da480a0daa7a",
"status": 2,
"preciseStatus": 3,
"lastStatusUpdateTimestamp": 1678901234,
"lastDeployAttemptTimestamp": 1678901234,
"intermediaryResourceStates": [],
"data": {
"subnetId": "subnet-1234567890abcdef0",
"vpcId": "vpc-1234567890abcdef0"
},
"failureReasons": [
"The link could not be created because the VPC does not exist."
]
}
},
"metadata": {},
"exports": {
"my-export": {
"value": "arn:aws:lambda:us-east-1:123456789012:function:my-lambda-function",
"type": "string",
"description": "The ARN of the lambda function",
"field": "resources[\"my-resource\"].spec.arn"
}
},
"childBlueprints": {},
"childDependencies": {},
"durations": {
"prepareDuration": 10000,
"totalDuration": 20000
}
}{
"message": "Unauthorized"
}{
"message": "Not found"
}{
"message": "An unexpected error occurred"
}