Azure DevOps · Schema
Release
An Azure DevOps release instance
AgileCI/CDDevOpsProject ManagementVersion Control
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | Unique numeric identifier of the release |
| name | string | Auto-generated release name |
| status | string | Current status of the release |
| createdOn | string | Date and time the release was created |
| modifiedOn | string | Date and time the release was last modified |
| createdBy | object | |
| modifiedBy | object | |
| createdFor | object | |
| description | string | Optional description for this release |
| releaseDefinition | object | |
| releaseDefinitionRevision | integer | Revision of the release definition used for this release |
| reason | string | Reason the release was created |
| environments | array | Environments in this release with their deployment status |
| artifacts | array | Artifacts used in this release |
| variables | object | Release-level variable overrides |
| keepForever | boolean | Whether to retain this release indefinitely |
| logsContainerUrl | string | URL to the logs container for this release |
| url | string | URL to access this release via the REST API |
| _links | object | HAL links for related resources |
| tags | array | Tags associated with this release |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Release",
"title": "Release",
"type": "object",
"description": "An Azure DevOps release instance",
"properties": {
"id": {
"type": "integer",
"description": "Unique numeric identifier of the release",
"example": 42
},
"name": {
"type": "string",
"description": "Auto-generated release name",
"example": "Release-42"
},
"status": {
"type": "string",
"description": "Current status of the release",
"enum": [
"undefined",
"draft",
"active",
"abandoned"
]
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time the release was created"
},
"modifiedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time the release was last modified"
},
"createdBy": {
"$ref": "#/components/schemas/IdentityRef"
},
"modifiedBy": {
"$ref": "#/components/schemas/IdentityRef"
},
"createdFor": {
"$ref": "#/components/schemas/IdentityRef"
},
"description": {
"type": "string",
"description": "Optional description for this release"
},
"releaseDefinition": {
"$ref": "#/components/schemas/ReleaseDefinitionShallowReference"
},
"releaseDefinitionRevision": {
"type": "integer",
"description": "Revision of the release definition used for this release"
},
"reason": {
"type": "string",
"description": "Reason the release was created",
"enum": [
"none",
"manual",
"continuousIntegration",
"schedule",
"pullRequest"
]
},
"environments": {
"type": "array",
"description": "Environments in this release with their deployment status",
"items": {
"$ref": "#/components/schemas/ReleaseEnvironment"
}
},
"artifacts": {
"type": "array",
"description": "Artifacts used in this release",
"items": {
"$ref": "#/components/schemas/Artifact"
}
},
"variables": {
"type": "object",
"description": "Release-level variable overrides",
"additionalProperties": {
"$ref": "#/components/schemas/ConfigurationVariableValue"
}
},
"keepForever": {
"type": "boolean",
"description": "Whether to retain this release indefinitely"
},
"logsContainerUrl": {
"type": "string",
"format": "uri",
"description": "URL to the logs container for this release"
},
"url": {
"type": "string",
"format": "uri",
"description": "URL to access this release via the REST API"
},
"_links": {
"type": "object",
"description": "HAL links for related resources",
"additionalProperties": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri"
}
}
}
},
"tags": {
"type": "array",
"description": "Tags associated with this release",
"items": {
"type": "string"
}
}
}
}