Schema for Policies
Octopus has a set number of inputs that are provided to evaluate policies against deployments. The following is the full schema that is passed into the engine to evaluate deployments:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Octopus Policy input schema",
"type": "object",
"properties": {
"Environment": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Slug": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Slug"
]
},
"Project": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Slug": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Slug"
]
},
"Space": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Slug": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Slug"
]
},
"Tenant": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Slug": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Slug"
]
},
"ProjectGroup": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Slug": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Slug"
]
},
"SkippedSteps": {
"type": "array",
"items": {}
},
"Steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Slug": {
"type": "string"
},
"ActionType": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"IsRequired": {
"type": "boolean"
},
"Source": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"SlugOrId": {
"type": "string"
},
"Version": {
"type": "string"
}
},
"required": [
"Type",
"SlugOrId"
]
}
},
"required": [
"Id",
"Slug",
"ActionType",
"Enabled",
"IsRequired",
"Source"
]
}
},
"Runbook": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Snapshot": {
"type": "string"
}
},
"required": [
"Id",
"Name",
"Snapshot"
]
}
},
"required": [
"Environment",
"Project",
"Space",
"SkippedSteps",
"Steps",
"ProjectGroup"
]
}
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Thursday, September 11, 2025