# Update workspace Updates the given workspace with new info. Endpoint: PUT /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier} Version: 1.0 Security: x-api-key ## Path parameters: - `org` (string, required) Org is the organisation identifier. Example: "a2u" - `project` (string, required) Project is the project identifier. Example: "41" - `identifier` (string, required) Workspace identifier. Example: "hx" ## Header parameters: - `Harness-Account` (string, required) Account is the internal customer account ID. Example: "3bu" ## Request fields (application/json): - `budget` (number) define the budget for a specific workspace Example: 0.45536554 - `cost_estimation_enabled` (boolean) define if cost estimation operations will be performed in this workspace Example: true - `default_pipelines` (object) List of default pipelines associated with this workspace and any per-workspace overrides. Example: {"Corporis aliquam quia.":{"project_pipeline":"Libero et laudantium consequatur.","workspace_pipeline":"Est dolores non ad magni iure."},"Nihil est corrupti sint inventore ducimus enim.":{"project_pipeline":"Libero et laudantium consequatur.","workspace_pipeline":"Est dolores non ad magni iure."},"Perspiciatis rerum quidem hic ratione qui.":{"project_pipeline":"Libero et laudantium consequatur.","workspace_pipeline":"Est dolores non ad magni iure."}} - `description` (string) Description provides long-form text about the resource. Example: "this is a more detailed explanation of the resource." - `environment_variables` (object, required) list of environment variables configured on the workspace. Example: {"Incidunt totam rerum qui qui recusandae.":{"key":"01","value":"Ullam aspernatur qui sed iusto.","value_type":"string"},"Quis odio enim enim et.":{"key":"01","value":"Ullam aspernatur qui sed iusto.","value_type":"string"}} - `name` (string, required) Name is the human readable name for the resource. Example: "resource name" - `provider_connector` (string, required) Provider Connector is the reference to the connector for the infrastructure provider. Example: "Aut id perferendis." - `provider_connectors` (array) define an array of provider connectors that belong to Workspace Example: [{"connector_ref":"jp","created":1627590400,"id":8501884255817918000,"terragrunt_provider":true,"type":"gcp","updated":1627686800,"workspace_id":5571489263414113000},{"connector_ref":"jp","created":1627590400,"id":8501884255817918000,"terragrunt_provider":true,"type":"gcp","updated":1627686800,"workspace_id":5571489263414113000},{"connector_ref":"jp","created":1627590400,"id":8501884255817918000,"terragrunt_provider":true,"type":"gcp","updated":1627686800,"workspace_id":5571489263414113000},{"connector_ref":"jp","created":1627590400,"id":8501884255817918000,"terragrunt_provider":true,"type":"gcp","updated":1627686800,"workspace_id":5571489263414113000}] - `provider_connectors.connector_ref` (string, required) Connector reference in harness platform. Example: "6" - `provider_connectors.created` (integer) Timestamp when the connector was created. Example: 1627590400 - `provider_connectors.id` (integer) ID PK for internal uses Example: 6011327796386148000 - `provider_connectors.terragrunt_provider` (boolean) Whether this workspace uses terragrunt to provision infrastructure - `provider_connectors.type` (string, required) Type indicates the connector type. Enum: "aws", "azure", "gcp" - `provider_connectors.updated` (integer) Timestamp when the connector was last updated. Example: 1627686800 - `provider_connectors.workspace_id` (integer) Workspace ID FK for internal uses Example: 3217464190686301000 - `provisioner` (string, required) Provisioner defines the provisioning tool to use. Example: "Atque et voluptas harum voluptatem vel debitis." - `provisioner_version` (string) Provisioner Version defines the tool version to use. Example: "Eligendi vitae assumenda molestiae omnis." - `prune_sensitive_data` (boolean) prune_sensitive_data is a flag to enable or disable pruning of sensitive data Example: true - `repository` (string) Repository is the name of the repository to use. Example: "Expedita eum voluptas dolores." - `repository_branch` (string) Repository Branch in which the code should be accessed. Example: "main" - `repository_commit` (string) Repository Commit/Tag in which the code should be accessed. Example: "abc10ed" - `repository_connector` (string) Repository Connector is the reference to the connector to use for this code. Example: "Id neque autem quam quibusdam porro fugit." - `repository_path` (string) Repository Path is the path in which the infra code resides. - `repository_sha` (string) Repository SHA in which the code should be accessed. Example: "abc10ed" - `repository_submodules` (string) repository_submodules is the instruction about whether to clone submodules in the pipeline step Enum: "false", "true", "recursive" - `run_all` (boolean) Run-All terragrunt modules. - `sparse_checkout` (string) List of patterens that will be used for sparse checkout option of git clone Example: "Repudiandae quasi aspernatur ex perferendis at." - `tags` (string) Tags associated with the workspace. Example: {"foo":"bar"} - `terraform_variable_files` (array) define an array of terraform variables files that belong to a different repository Example: [{"repository":"Occaecati a sint.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Est deleniti culpa.","repository_path":"","repository_sha":"abc10ed"},{"repository":"Occaecati a sint.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Est deleniti culpa.","repository_path":"","repository_sha":"abc10ed"},{"repository":"Occaecati a sint.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Est deleniti culpa.","repository_path":"","repository_sha":"abc10ed"}] - `terraform_variables` (object, required) list of terraform variables configured on the workspace. Example: {"Et magnam officia consequatur minima inventore.":{"key":"01","value":"Ullam aspernatur qui sed iusto.","value_type":"string"}} - `terragrunt_version` (string) Terragrunt Version to use when provisioner is terragrunt. Example: "Consequuntur debitis." - `variable_sets` (array) Attached Variable Sets references Example: ["Possimus labore quia voluptates maxime.","Et eveniet."] ## Response 200 fields (application/json): - `policy_evaluation` (object) The result of a single evaluation Example: {"account_id":"XRQAjvT37acOiXx9PRaQMF","action":"onrun","created":1636370209475,"details":[{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674}],"entity":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","entity_metadata":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","id":123,"input":"","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline,service"} - `policy_evaluation.account_id` (string, required) The Harness account in which the evaluation was performed Example: "XRQAjvT37acOiXx9PRaQMF" - `policy_evaluation.action` (string, required) The action that triggered evaluation Example: "onrun" - `policy_evaluation.created` (integer, required) The time at which the evaluation was performed in Unix time milliseconds Example: 1636370209475 - `policy_evaluation.details` (array, required) The detailed results of te evaluation Example: [{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674}] - `policy_evaluation.details.account_id` (string, required) Harness account ID associated with this policy set Example: "eBqAoNchMLKigC_qZ5EdC" - `policy_evaluation.details.action` (string, required) Action that triggers the policy set Example: "onrun" - `policy_evaluation.details.created` (integer, required) Time the policy set was created Example: 1636669297674 - `policy_evaluation.details.description` (string) Description of the policy set Example: "Captures critical production policies" - `policy_evaluation.details.details` (array, required) Example: [{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}] - `policy_evaluation.details.details.deny_messages` (array, required) The values of any rego rules as returned by the rego engine Example: ["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"] - `policy_evaluation.details.details.output` (any, required) The output returned by the rego engine when this policy was evaluated Example: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" - `policy_evaluation.details.details.policy` (object, required) Example: {"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674} - `policy_evaluation.details.details.policy.account_id` (string, required) Harness account ID associated with this policy Example: "eBqAoNchMLKigC_qZ5EdC" - `policy_evaluation.details.details.policy.created` (integer, required) Time the policy was created Example: 1636669297674 - `policy_evaluation.details.details.policy.identifier` (string, required) identifier of the policy Example: "policy-1" - `policy_evaluation.details.details.policy.name` (string, required) Name of the policy Example: "Pipeline Approval" - `policy_evaluation.details.details.policy.org_id` (string, required) Harness organization ID associated with this policy Example: "test-org" - `policy_evaluation.details.details.policy.project_id` (string, required) Harness project ID associated with this policy Example: "test-project" - `policy_evaluation.details.details.policy.rego` (string, required) Rego that defines the policy - `policy_evaluation.details.details.policy.updated` (integer, required) Time the policy was last updated Example: 1636669297674 - `policy_evaluation.details.details.rego_error` (string, required) Any errors returned by the rego engine when this policy was evaluated Example: "policy.rego:25: rego_parse_error: non-terminated string m == \"test" - `policy_evaluation.details.details.status` (string, required) The overall status for this individual policy indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.details.enabled` (boolean, required) Only enabled policy sets are evaluated when evaluating by type/action Example: true - `policy_evaluation.details.identifier` (string, required) Identifier of the policy set Example: "policyset-1" - `policy_evaluation.details.name` (string, required) Name of the policy set Example: "Production Policies" - `policy_evaluation.details.org_id` (string, required) Harness organization ID associated with this policy set Example: "test-org" - `policy_evaluation.details.project_id` (string, required) Harness project ID associated with this policy set Example: "test-project" - `policy_evaluation.details.status` (string, required) The overall status for this policy set indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.details.type` (string, required) Type of input suitable for the policy set Example: "pipeline" - `policy_evaluation.details.updated` (integer, required) Time the policy set was last updated Example: 1636669297674 - `policy_evaluation.entity` (string, required) An arbitrary user-supplied string that globally identifies the entity under evaluation Example: "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e" - `policy_evaluation.entity_metadata` (string, required) Additional arbitrary user-supplied metadata about the entity under evaluation Example: "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e" - `policy_evaluation.id` (integer, required) The ID of this evaluation Example: 123 - `policy_evaluation.input` (any, required) The input provided at evaluation time - `policy_evaluation.org_id` (string, required) The Harness organisation in which the evaluation was performed Example: "test-org" - `policy_evaluation.project_id` (string, required) The Harness project in which the evaluation was performed Example: "test-project" - `policy_evaluation.status` (string, required) The overall status of the evaluation indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.type` (string, required) The types of the entity under evaluation Example: "pipeline,service" ## Response 400 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `policy_evaluation` (object) The result of a single evaluation Example: {"account_id":"XRQAjvT37acOiXx9PRaQMF","action":"onrun","created":1636370209475,"details":[{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674}],"entity":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","entity_metadata":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","id":123,"input":"","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline,service"} - `policy_evaluation.account_id` (string, required) The Harness account in which the evaluation was performed Example: "XRQAjvT37acOiXx9PRaQMF" - `policy_evaluation.action` (string, required) The action that triggered evaluation Example: "onrun" - `policy_evaluation.created` (integer, required) The time at which the evaluation was performed in Unix time milliseconds Example: 1636370209475 - `policy_evaluation.details` (array, required) The detailed results of te evaluation Example: [{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674}] - `policy_evaluation.details.account_id` (string, required) Harness account ID associated with this policy set Example: "eBqAoNchMLKigC_qZ5EdC" - `policy_evaluation.details.action` (string, required) Action that triggers the policy set Example: "onrun" - `policy_evaluation.details.created` (integer, required) Time the policy set was created Example: 1636669297674 - `policy_evaluation.details.description` (string) Description of the policy set Example: "Captures critical production policies" - `policy_evaluation.details.details` (array, required) Example: [{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}] - `policy_evaluation.details.details.deny_messages` (array, required) The values of any rego rules as returned by the rego engine Example: ["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"] - `policy_evaluation.details.details.output` (any, required) The output returned by the rego engine when this policy was evaluated Example: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" - `policy_evaluation.details.details.policy` (object, required) Example: {"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674} - `policy_evaluation.details.details.policy.account_id` (string, required) Harness account ID associated with this policy Example: "eBqAoNchMLKigC_qZ5EdC" - `policy_evaluation.details.details.policy.created` (integer, required) Time the policy was created Example: 1636669297674 - `policy_evaluation.details.details.policy.identifier` (string, required) identifier of the policy Example: "policy-1" - `policy_evaluation.details.details.policy.name` (string, required) Name of the policy Example: "Pipeline Approval" - `policy_evaluation.details.details.policy.org_id` (string, required) Harness organization ID associated with this policy Example: "test-org" - `policy_evaluation.details.details.policy.project_id` (string, required) Harness project ID associated with this policy Example: "test-project" - `policy_evaluation.details.details.policy.rego` (string, required) Rego that defines the policy - `policy_evaluation.details.details.policy.updated` (integer, required) Time the policy was last updated Example: 1636669297674 - `policy_evaluation.details.details.rego_error` (string, required) Any errors returned by the rego engine when this policy was evaluated Example: "policy.rego:25: rego_parse_error: non-terminated string m == \"test" - `policy_evaluation.details.details.status` (string, required) The overall status for this individual policy indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.details.enabled` (boolean, required) Only enabled policy sets are evaluated when evaluating by type/action Example: true - `policy_evaluation.details.identifier` (string, required) Identifier of the policy set Example: "policyset-1" - `policy_evaluation.details.name` (string, required) Name of the policy set Example: "Production Policies" - `policy_evaluation.details.org_id` (string, required) Harness organization ID associated with this policy set Example: "test-org" - `policy_evaluation.details.project_id` (string, required) Harness project ID associated with this policy set Example: "test-project" - `policy_evaluation.details.status` (string, required) The overall status for this policy set indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.details.type` (string, required) Type of input suitable for the policy set Example: "pipeline" - `policy_evaluation.details.updated` (integer, required) Time the policy set was last updated Example: 1636669297674 - `policy_evaluation.entity` (string, required) An arbitrary user-supplied string that globally identifies the entity under evaluation Example: "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e" - `policy_evaluation.entity_metadata` (string, required) Additional arbitrary user-supplied metadata about the entity under evaluation Example: "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e" - `policy_evaluation.id` (integer, required) The ID of this evaluation Example: 123 - `policy_evaluation.input` (any, required) The input provided at evaluation time - `policy_evaluation.org_id` (string, required) The Harness organisation in which the evaluation was performed Example: "test-org" - `policy_evaluation.project_id` (string, required) The Harness project in which the evaluation was performed Example: "test-project" - `policy_evaluation.status` (string, required) The overall status of the evaluation indicating whether it passed Enum: "error", "warning", "pass" - `policy_evaluation.type` (string, required) The types of the entity under evaluation Example: "pipeline,service" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 401 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 403 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 404 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 408 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 409 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 423 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 499 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 500 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 502 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? Example: true - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? Example: true - `timeout` (boolean, required) Is the error a timeout? Example: true