Workflows

PreviousCodification NextSelf-Service

Last updated 6 days ago

Was this helpful?

Delete a Guardrail Rule

delete

Deletes a Guardrail Rule and its Associated Notification

Authorizations

Path parameters

ruleIdstringrequired

Unique identifier of the Guardrail Rule

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.firefly.ai/api/v2/guardrails/{ruleId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

500

{
  "status": 200,
  "message": "Guardrail rule and notification deleted successfully"
}

Guardrail Rule Deleted Successfully

Delete a workspace

delete

Deletes a specific workspace and its associated data

Authorizations

Path parameters

workspaceIdstringrequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.firefly.ai/api/v2/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

500

{
  "status": 200,
  "data": {
    "message": "Workspace deleted successfully"
  }
}

Workspace deleted successfully

List Workspaces

post

Lists all Workspaces with Filtering and Sorting Options. Supports VCS Providers Integration.

Authorizations

Query parameters

pageinteger · default: 0optional

pageSizeinteger · min: 1 · default: 25optional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/workspaces/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "projection": [
      "text"
    ],
    "searchValue": "text",
    "filters": {
      "workspaceName": [
        "production-infra"
      ],
      "repositories": [
        "org/repo-name"
      ],
      "ciTool": [
        "github-actions"
      ],
      "labels": [
        "text"
      ],
      "status": [
        "plan_success"
      ],
      "isManagedWorkflow": true,
      "vcsType": [
        "github"
      ],
      "$or": {
        "workspaceName": [
          "production-infra"
        ],
        "repositories": [
          "org/repo-name"
        ],
        "ciTool": [
          "github-actions"
        ],
        "labels": [
          "text"
        ],
        "status": [
          "plan_success"
        ],
        "isManagedWorkflow": true,
        "vcsType": [
          "github"
        ]
      }
    },
    "sort": [
      {
        "lastRunTime": {
          "order": -1
        },
        "workspaceName": {
          "order": -1
        },
        "repository": {
          "order": -1
        },
        "terraformVersion": {
          "order": -1
        },
        "lastRunStatus": {
          "order": -1
        },
        "ciTool": {
          "order": -1
        }
      }
    ]
  }'

200

400

401

403

404

500

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "createdAt": "2025-04-03T01:47:38.612Z",
    "updatedAt": "2025-04-03T01:47:38.612Z",
    "workspaceId": "507f1f77bcf86cd799439012",
    "workspaceName": "production-infra",
    "repo": "org/repo-name",
    "repoUrl": "https://github.com/org/repo-name",
    "vcsType": "github",
    "runnerType": "github-actions",
    "lastRunStatus": {
      "description": "text"
    },
    "lastApplyTime": "2025-04-03T01:47:38.612Z",
    "lastPlanTime": "2025-04-03T01:47:38.612Z",
    "lastRunTime": "2025-04-03T01:47:38.612Z",
    "iacType": "terraform",
    "iacTypeVersion": "1.0.11",
    "backendSummary": {
      "backendType": "s3",
      "backendConfig": {
        "bucket": "terraform-state",
        "key": "prod/terraform.tfstate"
      },
      "iacStackId": "stack-123",
      "managedResourceCount": 42
    },
    "labels": [
      "prod",
      "terraform"
    ],
    "runsCount": 5,
    "isWorkflowManaged": true,
    "guardrails": [
      "cost",
      "security"
    ]
  }
]

List of Workspaces Retrieved Successfully

Update Workspace Labels

put

Updates Labels for a specific Workspace

Authorizations

Path parameters

workspaceIdstringrequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

labelsstring[]required

List of labels to assign to the workspace

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.firefly.ai/api/v2/workspaces/{workspaceId}/labels' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "labels": [
      "text"
    ]
  }'

200

400

401

403

404

500

{
  "id": "507f1f77bcf86cd799439015",
  "workspaceName": "production-infra",
  "labels": [
    "production",
    "terraform",
    "critical"
  ],
  "updatedAt": "2025-04-03T01:47:38.612Z"
}

Workspace Labels Updated Successfully

List Workspace Runs

post

Lists all Runs for a specific Workspace

Authorizations

Path parameters

workspaceIdstringrequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageinteger · default: 0optional

pageSizeinteger · min: 1 · default: 25optional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/workspaces/{workspaceId}/runs/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "projection": [
      "text"
    ],
    "searchValue": "text",
    "filters": {
      "runId": [
        "run-123456"
      ],
      "runName": [
        "Deploy to Production"
      ],
      "status": [
        "plan_success"
      ],
      "pullRequestUrl": [
        "https://github.com/org/repo/pull/123"
      ],
      "branch": [
        "main"
      ],
      "commitId": [
        "abc123def456"
      ],
      "ciTool": [
        "github-actions"
      ],
      "buildId": [
        "build-789012"
      ],
      "buildName": [
        "CI Build"
      ],
      "buildUrl": [
        "https://github.com/org/repo/actions/runs/789012"
      ],
      "vcsType": [
        "github"
      ],
      "repository": [
        "org/repo"
      ],
      "repositoryUrl": [
        "https://github.com/org/repo"
      ],
      "title": [
        "Update infrastructure for new feature"
      ],
      "createdAt": "2025-04-03T01:47:38.612Z",
      "updatedAt": "2025-04-03T01:47:38.612Z",
      "$or": {
        "runId": [
          "run-123456"
        ],
        "runName": [
          "Deploy to Production"
        ],
        "status": [
          "plan_success"
        ],
        "pullRequestUrl": [
          "https://github.com/org/repo/pull/123"
        ],
        "branch": [
          "main"
        ],
        "commitId": [
          "abc123def456"
        ],
        "ciTool": [
          "github-actions"
        ],
        "buildId": [
          "build-789012"
        ],
        "buildName": [
          "CI Build"
        ],
        "buildUrl": [
          "https://github.com/org/repo/actions/runs/789012"
        ],
        "vcsType": [
          "github"
        ],
        "repository": [
          "org/repo"
        ],
        "repositoryUrl": [
          "https://github.com/org/repo"
        ],
        "title": [
          "Update infrastructure for new feature"
        ],
        "createdAt": "2025-04-03T01:47:38.612Z",
        "updatedAt": "2025-04-03T01:47:38.612Z"
      }
    },
    "sort": [
      {
        "updatedAt": {
          "order": -1
        },
        "title": {
          "order": -1
        },
        "commitId": {
          "order": -1
        },
        "branch": {
          "order": -1
        },
        "status": {
          "order": -1
        },
        "ciTool": {
          "order": -1
        },
        "vcsType": {
          "order": -1
        },
        "repository": {
          "order": -1
        }
      }
    ]
  }'

200

400

401

403

404

500

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "createdAt": "2025-04-03T01:47:38.612Z",
    "updatedAt": "2025-04-03T01:47:38.612Z",
    "workspaceId": "507f1f77bcf86cd799439012",
    "workspaceName": "production-infra",
    "runId": "run-123456",
    "runName": "Deploy to Production",
    "status": "plan_success",
    "pullRequestId": "123",
    "pullRequestUrl": "https://github.com/org/repo/pull/123",
    "branch": "main",
    "commitId": "abc123def456",
    "commitUrl": "https://github.com/org/repo/commit/abc123def456",
    "runnerType": "github-actions",
    "buildId": "build-789012",
    "buildUrl": "https://github.com/org/repo/actions/runs/789012",
    "buildName": "CI Build",
    "vcsType": "github",
    "repo": "org/repo",
    "repoUrl": "https://github.com/org/repo",
    "ownerSummary": {
      "email": "john.doe@example.com",
      "name": "John Doe",
      "initials": "JD",
      "customColor": "#00000F"
    },
    "title": "Update infrastructure for new feature",
    "terraformVersion": "1.0.11",
    "iacType": "terraform",
    "backendSummary": {
      "backendType": "s3",
      "backendConfig": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "iacStackId": "text",
      "managedResourceCount": 1
    },
    "planTaskId": "507f1f77bcf86cd799439013",
    "applyTaskId": "507f1f77bcf86cd799439014",
    "plan": [
      {
        "id": "507f1f77bcf86cd799439011",
        "accountId": "507f1f77bcf86cd799439011",
        "createdAt": "2025-04-03T01:47:38.612Z",
        "updatedAt": "2025-04-03T01:47:38.612Z",
        "contentKeys": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "completed",
        "resultStatus": "success",
        "type": {
          "description": "text"
        },
        "guardrailsSummary": {
          "total": 10,
          "passed": 8,
          "failed": 2,
          "violations": [
            {
              "id": "v1",
              "severity": "high",
              "message": "Resource does not have required tags"
            }
          ],
          "description": "text"
        },
        "backendSummary": {
          "type": "s3",
          "config": {
            "bucket": "terraform-state",
            "key": "prod/terraform.tfstate"
          },
          "resources": 42,
          "description": "text"
        },
        "changedFilesCodeSummary": {
          "total": 5,
          "added": 2,
          "modified": 3,
          "deleted": 0,
          "files": [
            {
              "path": "main.tf",
              "type": "modified"
            }
          ],
          "description": "text"
        },
        "vcsType": {
          "description": "text"
        },
        "runnerType": {
          "description": "text"
        }
      }
    ],
    "apply": [
      {
        "id": "507f1f77bcf86cd799439011",
        "accountId": "507f1f77bcf86cd799439011",
        "createdAt": "2025-04-03T01:47:38.612Z",
        "updatedAt": "2025-04-03T01:47:38.612Z",
        "contentKeys": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "completed",
        "resultStatus": "success",
        "type": {
          "description": "text"
        },
        "guardrailsSummary": {
          "total": 10,
          "passed": 8,
          "failed": 2,
          "violations": [
            {
              "id": "v1",
              "severity": "high",
              "message": "Resource does not have required tags"
            }
          ],
          "description": "text"
        },
        "backendSummary": {
          "type": "s3",
          "config": {
            "bucket": "terraform-state",
            "key": "prod/terraform.tfstate"
          },
          "resources": 42,
          "description": "text"
        },
        "changedFilesCodeSummary": {
          "total": 5,
          "added": 2,
          "modified": 3,
          "deleted": 0,
          "files": [
            {
              "path": "main.tf",
              "type": "modified"
            }
          ],
          "description": "text"
        },
        "vcsType": {
          "description": "text"
        },
        "runnerType": {
          "description": "text"
        }
      }
    ]
  }
]

List of Workspace Runs Retrieved Successfully

List Run Resources

post

Lists Resources Affected by a Run

Authorizations

Path parameters

runIdstringrequired

Unique identifier of the Run

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageinteger · default: 0optional

pageSizeinteger · min: 1 · default: 25optional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/tasks/{runId}/resources/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "projection": [
      "text"
    ],
    "searchValue": "text",
    "mode": "table",
    "filters": {
      "action": {
        "0": "create"
      },
      "hasDiagnostics": true,
      "taskType": {
        "0": "post-plan"
      },
      "resourceId": {
        "0": "aws_s3_bucket.logs"
      },
      "providerName": [
        "aws"
      ],
      "isDrifted": false,
      "$or": {
        "action": {
          "0": "create"
        },
        "hasDiagnostics": true,
        "taskType": {
          "0": "post-plan"
        },
        "resourceId": {
          "0": "aws_s3_bucket.logs"
        },
        "providerName": [
          "aws"
        ],
        "isDrifted": false
      }
    },
    "sort": [
      {
        "name": {
          "order": -1
        },
        "mode": {
          "order": -1
        },
        "action": {
          "order": -1
        },
        "isDrifted": {
          "order": -1
        },
        "type": {
          "order": -1
        },
        "taskType": {
          "order": -1
        },
        "providerName": {
          "order": -1
        },
        "updatedAt": {
          "order": -1
        },
        "createdAt": {
          "order": -1
        }
      }
    ]
  }'

200

400

401

403

404

500

{
  "resources": [
    {
      "id": "507f1f77bcf86cd799439011",
      "accountId": "507f1f77bcf86cd799439011",
      "createdAt": "2025-04-03T01:47:38.612Z",
      "updatedAt": "2025-04-03T01:47:38.612Z",
      "taskId": "507f1f77bcf86cd799439013",
      "name": "aws_instance.example",
      "type": "aws_instance",
      "mode": "managed",
      "action": {
        "description": "text"
      }
    },
    {
      "isDrifted": false,
      "taskType": {
        "description": "text"
      },
      "dataType": {
        "description": "text"
      },
      "providerName": "aws",
      "providerType": "aws",
      "providerVersion": "4.0.0"
    }
  ]
}

Run resources retrieved successfully

List run changed code

post

Lists code changes grouped by folders with file metadata

Authorizations

Path parameters

runIdstringrequired

Unique identifier of the run

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageinteger · default: 0optional

pageSizeinteger · min: 1 · default: 25optional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/tasks/{runId}/changed-files-code/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "projection": [
      "text"
    ],
    "searchValue": "text",
    "filters": {
      "taskId": {
        "0": "507f1f77bcf86cd799439013"
      },
      "suffix": {
        "0": "tf"
      },
      "taskType": {
        "0": "post-plan"
      },
      "filePath": {
        "0": "infrastructure/main.tf"
      },
      "$or": {
        "taskId": {
          "0": "507f1f77bcf86cd799439013"
        },
        "suffix": {
          "0": "tf"
        },
        "taskType": {
          "0": "post-plan"
        },
        "filePath": {
          "0": "infrastructure/main.tf"
        }
      }
    },
    "sort": [
      {
        "taskType": {
          "order": -1
        },
        "suffix": {
          "order": -1
        },
        "updatedAt": {
          "order": -1
        }
      }
    ]
  }'

200

400

401

403

404

500

{
  "infrastructure": [
    {
      "id": "507f1f77bcf86cd799439014",
      "filePath": "infrastructure/main.tf",
      "folderPath": "infrastructure",
      "fileSuffix": "tf",
      "changes": {
        "additions": 10,
        "deletions": 5
      }
    }
  ],
  "modules": [
    {
      "id": "507f1f77bcf86cd799439015",
      "filePath": "modules/network/main.tf",
      "folderPath": "modules/network",
      "fileSuffix": "tf",
      "changes": {
        "additions": 3,
        "deletions": 1
      }
    }
  ]
}

Run changed code retrieved successfully

List Guardrail Rules

post

Returns a list of guardrails rules based on filter criteria

Authorizations

Query parameters

pageinteger · default: 0optional

pageSizeinteger · min: 1 · default: 25optional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/guardrails/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "projection": [
      "text"
    ],
    "searchValue": "text",
    "filters": {
      "createdBy": [
        "John Doe"
      ],
      "type": [
        "policy",
        "cost"
      ],
      "labels": [
        "production"
      ],
      "repositories": [
        "my-repo"
      ],
      "workspaces": [
        "my-workspace"
      ],
      "branches": [
        "main"
      ],
      "$or": {
        "createdBy": [
          "John Doe"
        ],
        "type": [
          "policy",
          "cost"
        ],
        "labels": [
          "production"
        ],
        "repositories": [
          "my-repo"
        ],
        "workspaces": [
          "my-workspace"
        ],
        "branches": [
          "main"
        ]
      }
    },
    "sort": [
      {
        "createdAt": {
          "order": -1
        },
        "accountId": {
          "order": -1
        },
        "createdBy": {
          "order": -1
        },
        "name": {
          "order": -1
        },
        "severity": {
          "order": -1
        }
      }
    ]
  }'

200

400

401

403

404

500

[
  {
    "id": "507f1f77bcf86cd799439012",
    "accountId": "507f1f77bcf86cd799439012",
    "createdBy": "507f1f77bcf86cd799439012",
    "name": "text",
    "type": "policy",
    "scope": {
      "workspaces": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "repositories": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "branches": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "labels": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      }
    },
    "criteria": {
      "cost": {
        "thresholdAmount": 1,
        "thresholdPercentage": 1
      },
      "policy": {
        "severity": "text",
        "policies": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        }
      },
      "resource": {
        "actions": [
          "create"
        ],
        "regions": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "assetTypes": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "specificResources": [
          "text"
        ]
      },
      "tag": {
        "tagEnforcementMode": "requiredTags",
        "requiredTags": [
          "text"
        ],
        "requiredValues": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      }
    },
    "isEnabled": true,
    "createdAt": "2025-04-03T01:47:38.612Z",
    "updatedAt": "2025-04-03T01:47:38.612Z",
    "notificationId": "507f1f77bcf86cd799439012",
    "severity": 0
  }
]

List of guardrail rules retrieved successfully

Create a new Guardrail Rule

post

Creates a new guardrail rule with optional notification setup

Authorizations

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/guardrails' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": "507f1f77bcf86cd799439012",
    "createdBy": "507f1f77bcf86cd799439012",
    "name": "text",
    "type": "policy",
    "scope": {
      "workspaces": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "repositories": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "branches": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "labels": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      }
    },
    "criteria": {
      "cost": {
        "thresholdAmount": 1,
        "thresholdPercentage": 1
      },
      "policy": {
        "severity": "text",
        "policies": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        }
      },
      "resource": {
        "actions": [
          "create"
        ],
        "regions": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "assetTypes": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "specificResources": [
          "text"
        ]
      },
      "tag": {
        "tagEnforcementMode": "requiredTags",
        "requiredTags": [
          "text"
        ],
        "requiredValues": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      }
    },
    "isEnabled": true,
    "createdAt": "2025-04-03T01:47:38.612Z",
    "updatedAt": "2025-04-03T01:47:38.612Z",
    "notificationId": "507f1f77bcf86cd799439012",
    "severity": 0
  }'

200

400

401

403

404

500

{
  "ruleId": "507f1f77bcf86cd799439011",
  "notificationId": "507f1f77bcf86cd799439012"
}

Guardrail Rule Created Successfully

Update a Guardrail Rule

patch

Updates an existing Guardrail Rule and its Notifications

Authorizations

Path parameters

ruleIdstringrequired

Unique identifier of the Guardrail Rule

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

idstringread-onlyoptional

Unique identifier of the guardrail rule

Example: 507f1f77bcf86cd799439012

Pattern: ^[0-9a-fA-F]{24}$

accountIdstringoptional

Unique identifier of the associated account

Example: 507f1f77bcf86cd799439012

Pattern: ^[0-9a-fA-F]{24}$

createdBystringoptional

Unique identifier of the user who created the rule

Example: 507f1f77bcf86cd799439012

Pattern: ^[0-9a-fA-F]{24}$

namestringoptional

Name of the guardrail rule

typestring · enumoptional

Type of the guardrail rule

Available options:

scopeall ofoptional

Scope of the guardrail rule

criteriaobjectoptional

isEnabledbooleanoptional

Whether the rule is enabled

createdAtstring · date-timeoptional

Timestamp when the rule was created

updatedAtstring · date-timeoptional

Timestamp when the rule was last updated

notificationIdstringoptional

Unique identifier of the associated notification configuration

Example: 507f1f77bcf86cd799439012

Pattern: ^[0-9a-fA-F]{24}$

severityinteger · enumoptional

Severity level of the guardrail rule

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.firefly.ai/api/v2/guardrails/{ruleId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": "507f1f77bcf86cd799439012",
    "createdBy": "507f1f77bcf86cd799439012",
    "name": "text",
    "type": "policy",
    "scope": {
      "workspaces": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "repositories": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "branches": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      },
      "labels": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      }
    },
    "criteria": {
      "cost": {
        "thresholdAmount": 1,
        "thresholdPercentage": 1
      },
      "policy": {
        "severity": "text",
        "policies": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        }
      },
      "resource": {
        "actions": [
          "create"
        ],
        "regions": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "assetTypes": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        },
        "specificResources": [
          "text"
        ]
      },
      "tag": {
        "tagEnforcementMode": "requiredTags",
        "requiredTags": [
          "text"
        ],
        "requiredValues": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      }
    },
    "isEnabled": true,
    "createdAt": "2025-04-03T01:47:38.612Z",
    "updatedAt": "2025-04-03T01:47:38.612Z",
    "notificationId": "507f1f77bcf86cd799439012",
    "severity": 0
  }'

200

400

401

403

404

500

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Enforce S3 Encryption",
  "enabled": true,
  "updatedAt": "2024-11-11T10:00:00Z"
}

Guardrail Rule Updated Successfully

Workflows

Workflows

Workspaces

Guardrails

Workspaces

Guardrails

Delete a Guardrail Rule

Delete a workspace

List Workspaces

Update Workspace Labels

List Workspace Runs

List Run Resources

List run changed code

List Guardrail Rules

Create a new Guardrail Rule

Update a Guardrail Rule

Workspaces

Guardrails

Workspaces

Guardrails

Delete a Guardrail Rule

Delete a workspace

List Workspaces

Show child attributes

Show child attributes

Update Workspace Labels

List Workspace Runs

Show child attributes

Show child attributes

List Run Resources

Show child attributes

Show child attributes

List run changed code

Show child attributes

Show child attributes

List Guardrail Rules

Show child attributes

Show child attributes

Create a new Guardrail Rule

Show child attributes

Show child attributes

Update a Guardrail Rule

Show child attributes

Show child attributes

Show child attributes