{ "opencollection": "1.0.0", "info": { "name": "Prefect Cloud API", "version": "0.8.4" }, "items": [ { "info": { "name": "Workspace Scopes", "type": "folder" }, "items": [ { "info": { "name": "Get Workspace Scopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/workspace_scopes" }, "docs": "Get Workspace Scopes" } ] }, { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "List Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/permissions" }, "docs": "List account permissions" }, { "info": { "name": "Read Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an account by id." }, { "info": { "name": "Update Account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account by id." }, { "info": { "name": "Delete Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Account" }, { "info": { "name": "Read Account Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read Account Settings" }, { "info": { "name": "Update Account Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Account Settings" }, { "info": { "name": "Read Account Domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read Account Domains" }, { "info": { "name": "Update Account Domains", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account's associated domains." }, { "info": { "name": "Read Account Usage Limits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/usage_limits", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read Account Usage Limits" }, { "info": { "name": "Read Account Usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/usage", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read Account Usage" } ] }, { "info": { "name": "Account Images", "type": "folder" }, "items": [ { "info": { "name": "Get Account Image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/image", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get Account Image" }, { "info": { "name": "Upload Account Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/image", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload Account Image" }, { "info": { "name": "Delete Account Image", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/image", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Account Image" } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Create Team", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/teams/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update a team's metadata.\n\nRequired account permissions: `create:team`" }, { "info": { "name": "Read Team", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a team by id.\n\nRequired account permissions: `read:team`" }, { "info": { "name": "Update Team", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired account permissions: `update:team`" }, { "info": { "name": "Delete Team", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a team by id.\n\nRequired account permissions: `delete:team`" }, { "info": { "name": "Read Teams", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/teams/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for teams.\n\nRequired account permissions: `read:team`" }, { "info": { "name": "Upsert Team Members", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/teams/:id/members", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert team memberships.\n\nRequired account permissions: `update:team`" }, { "info": { "name": "Remove Team Member", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/teams/:team_id/members/:actor_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "team_id", "value": "", "type": "path" }, { "name": "actor_id", "value": "", "type": "path" } ] }, "docs": "Remove a member from a team.\n\nRequired account permissions: `update:team`" } ] }, { "info": { "name": "Account Memberships", "type": "folder" }, "items": [ { "info": { "name": "Read Account Memberships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for account memberships.\n\nRequired account permissions: `read:account_membership`" }, { "info": { "name": "Count Account Memberships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/count", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for account memberships count\n\nRequired account permissions: `read:account_membership`" }, { "info": { "name": "Read Account Membership By User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/by-user/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an Account Membership by user id.\n\nLooks up the membership for the given user within the account and returns\nenriched member details including timezone and team memberships.\n\nReturns 404 when the user is not a member of the account (e.g. they have\nsince been removed), allowing the frontend to show a \"deactivated user\"\nfallback.\n\nRequired account permissions: `read:account_membership`" }, { "info": { "name": "Read Account Membership By Bot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/by-bot/:bot_id", "params": [ { "name": "bot_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an Account Membership by bot id.\n\nLooks up the membership for the given bot within the account and returns\nenriched member details including team memberships.\n\nReturns 404 when the bot is not a member of the account.\n\nRequired account permissions: `read:account_membership`" }, { "info": { "name": "Read Account Membership", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an Account Membership by membership id.\n\nReturns enriched member details including timezone and team memberships.\nReturns 404 for bot memberships — use the bots endpoint for those.\n\nRequired account permissions: `read:account_membership`" }, { "info": { "name": "Update Account Membership", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account membership by id.\n\nRequired account permissions: `update:account_membership`" }, { "info": { "name": "Delete Account Membership", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete an account membership by id.\nThis will also delete any workspace accesses that the membership's actor\nhas under the account.\n\nRequired account permissions: `delete:account_membership`" }, { "info": { "name": "Toggle Account Membership Active", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/:id/active", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired account permissions: `update:account_membership`" }, { "info": { "name": "Bulk Set Account Membership Active", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/account_memberships/set_active", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired account permissions: `update:account_membership`" } ] }, { "info": { "name": "Account Roles", "type": "folder" }, "items": [ { "info": { "name": "Read Account Role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/account_roles/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an Account Role by id.\n\nRequired account permissions: `read:account_role`" }, { "info": { "name": "Update Account Role", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/account_roles/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account role by id.\n\nRequired account permissions: `update:account_role`" }, { "info": { "name": "Delete Account Role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/account_roles/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete an account role by id.\n\nRequired account permissions: `delete:account_role`" }, { "info": { "name": "Read Account Roles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/account_roles/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for account roles.\n\nRequired account permissions: `read:account_role`" } ] }, { "info": { "name": "Account SSO", "type": "folder" }, "items": [ { "info": { "name": "Read Sso Setup Url", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/sso/setup_url", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an SSO connection setup URL for a given account\n\nReturns a URL if the account doesn't already have SSO configured\n\nRequired account permissions: `administrate:sso`" }, { "info": { "name": "Read Dsync Setup Url", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/sso/dsync_setup_url", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get an Directory Sync connection setup URL for a given account\n\nReturns a URL if the account doesn't already have Directory Sync configured\n\nRequired account permissions: `administrate:sso`" }, { "info": { "name": "Validate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/sso/validate", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate that the current actor has recently authenticated with the\nAccount's authenticator.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/sso/integrations", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Return details about an Account's SSO / SCIM integrations.\n\nRequired account permissions: `administrate:sso`" }, { "info": { "name": "Remove Integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/sso/integrations/:integration_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "integration_id", "value": "", "type": "path" } ] }, "docs": "Return details about an Account's SSO / SCIM integrations.\n\nRequired account permissions: `administrate:sso`" } ] }, { "info": { "name": "Bots", "type": "folder" }, "items": [ { "info": { "name": "Create Bot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/bots/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Bot\n\nRequired account permissions: `create:bot`" }, { "info": { "name": "Read Bot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a bot by id.\n\nRequired account permissions: `read:bot`" }, { "info": { "name": "Update Bot", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a bot by id.\n\nRequired account permissions: `update:bot`" }, { "info": { "name": "Delete Bot", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a bot by id.\n\nRequired account permissions: `delete:bot`" }, { "info": { "name": "Read Bots", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/bots/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for bots.\n\nRequired account permissions: `read:bot`" }, { "info": { "name": "Rotate Api Key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id/rotate_api_key", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotate the api key for a Bot.\n\nRequired account permissions: `update:bot`" }, { "info": { "name": "Read Bot Api Keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id/read_bot_api_keys", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a bot's api keys by id.\n\nRequired account permissions: `read:bot`" }, { "info": { "name": "Delete Bot Api Key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/bots/:id/delete_bot_api_key/:api_key_id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "api_key_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a bot's api key by id.\n\nRequired account permissions: `update:bot`" } ] }, { "info": { "name": "Invitations", "type": "folder" }, "items": [ { "info": { "name": "Create Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/invitations/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite user(s) to an account.\nAny PENDING invitations for the same user to the account will be revoked.\n\nRequired account permissions: `create:invitation`" }, { "info": { "name": "Read Invitation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/invitations/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get an invitation by id\n\nRequired account permissions: `read:invitation`" }, { "info": { "name": "Read Invitations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/invitations/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for invitations\n\nRequired account permissions: `read:invitation`" }, { "info": { "name": "Count Invitations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/invitations/count", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for invitations count\n\nRequired account permissions: `read:invitation`" }, { "info": { "name": "Revoke Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/invitations/:id/revoke", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an invitation by id\n\nRequired account permissions: `update:invitation`" }, { "info": { "name": "Accept Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/invitations/:id/accept", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "invite_code", "value": "", "type": "query" } ] }, "docs": "Accept an invitation" }, { "info": { "name": "Reject Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/invitations/:id/reject", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "invite_code", "value": "", "type": "query" } ] }, "docs": "Reject an invitation" } ] }, { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "Create Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Workspace\n\nRequired account permissions: `create:workspace`" }, { "info": { "name": "Read Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a workspace by id.\n\nRequired account permissions: `read:workspace`" }, { "info": { "name": "Update Workspace", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a workspace by id.\n\nRequired workspace scopes: `write_workspace_settings`" }, { "info": { "name": "Delete Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a workspace by id.\n\nRequired workspace scopes: `manage_workspace_settings`" }, { "info": { "name": "Read Managed Execution Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/managed_execution/details", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Retrieves information about the managed execution usage and terms for a given workspace.\nThis includes the total compute time in seconds utilized by the workspace during the current billing period,\nas well as limits pertaining to the account terms, such as concurrency, work pool, and compute limits.\n\nReturns:\n WorkspaceLimitsUsageResponse: An object containing the compute usage in seconds and limits on\n concurrency, work pool, and compute usage for the specified workspace.\n\nRequired accoun" }, { "info": { "name": "Read Workspaces", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for workspaces.\n\nRequired account permissions: `read:workspace`" }, { "info": { "name": "Transfer Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/transfer", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transfer a workspace to a new account\n\nRequired account permissions: `delete:workspace`" }, { "info": { "name": "Validate Transfer Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/validate_transfer", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate transfer of a workspace to a new account, returning any validation errors\n\nRequired account permissions: `delete:workspace`" }, { "info": { "name": "Find Workspace Without Account Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Redirects to the full account-scoped URL of a workspace" }, { "info": { "name": "Read Workspace Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/settings", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read a workspace's settings by id.\n\nRequired workspace scopes: `see_workspace_settings`" }, { "info": { "name": "Update Workspace Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/settings", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a workspace's settings by id.\n\nRequired workspace scopes: `write_workspace_settings`" } ] }, { "info": { "name": "Workspace Roles", "type": "folder" }, "items": [ { "info": { "name": "Create Workspace Role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspace_roles/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom workspace role.\n\nRequired account permissions: `create:workspace_role`" }, { "info": { "name": "Read Workspace Role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspace_roles/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read a workspace role.\n\nRequired account permissions: `read:workspace_role`" }, { "info": { "name": "Update Workspace Role", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspace_roles/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a custom workspace role.\n\nRequired account permissions: `update:workspace_role`" }, { "info": { "name": "Delete Workspace Role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspace_roles/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a custom workspace role.\n\nRequired account permissions: `delete:workspace_role`" }, { "info": { "name": "Read Workspace Roles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspace_roles/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for workspace roles.\n\nRequired account permissions: `read:workspace_role`" } ] }, { "info": { "name": "Rate Limits", "type": "folder" }, "items": [ { "info": { "name": "Read Rate Limit Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/status", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Check whether the account is currently exceeding any rate limits.\n\nReturns a list of bucket names that are currently exceeded. The frontend\nuses this to display a warning banner. The exceeded status auto-clears\n~15 minutes after the last denied request.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Read Rate Limit Usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/usage", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "The start date of the usage period" }, { "name": "until", "value": "", "type": "query", "description": "The end date of the usage period" }, { "name": "keys", "value": "", "type": "query", "description": "The keys to query usage for" } ] }, "docs": "Read rate limit usage for a given account.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Download Rate Limit Usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/usage/download", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "The start date of the usage period" }, { "name": "until", "value": "", "type": "query", "description": "The end date of the usage period" }, { "name": "keys", "value": "", "type": "query", "description": "The keys to query usage for" } ] }, "docs": "Download rate limit usage for a given account as a CSV file.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Read Orchestration Api Grouped Usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/orchestration-api", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Start time of the usage period (inclusive)" }, { "name": "until", "value": "", "type": "query", "description": "End time of the usage period (inclusive)" }, { "name": "group_by", "value": "", "type": "query", "description": "The dimension to group usage by (e.g., workspace_id, api_key_name)" }, { "name": "workspace_id", "value": "", "type": "query", "description": "Filter by workspace ID" }, { "name": "api_key_name", "value": "", "type": "query", "description": "Filter by API key name" }, { "name": "actor_name", "value": "", "type": "query", "description": "Filter by actor name" } ] }, "docs": "Read orchestration API rate limit usage grouped by a dimension over time.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Read Events Grouped Usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/events", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Start time of the usage period (inclusive)" }, { "name": "until", "value": "", "type": "query", "description": "End time of the usage period (inclusive)" }, { "name": "group_by", "value": "", "type": "query", "description": "The dimension to group usage by (e.g., workspace_id, event_name)" }, { "name": "workspace_id", "value": "", "type": "query", "description": "Filter by workspace ID" }, { "name": "api_key_name", "value": "", "type": "query", "description": "Filter by API key name" }, { "name": "actor_name", "value": "", "type": "query", "description": "Filter by actor name" } ] }, "docs": "Read events rate limit usage grouped by a dimension over time.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "List Api Key Names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/api-key-names", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Start time of the search period (inclusive)" }, { "name": "until", "value": "", "type": "query", "description": "End time of the search period (inclusive)" }, { "name": "search", "value": "", "type": "query", "description": "Fuzzy search string (case-insensitive substring match)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "keys", "value": "", "type": "query", "description": "Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)" } ] }, "docs": "List distinct API key names from rate limit usage data.\n\nReturns API key names ordered by most recently seen, with optional\nfuzzy search filtering.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "List Actor Names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limits/actor-names", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Start time of the search period (inclusive)" }, { "name": "until", "value": "", "type": "query", "description": "End time of the search period (inclusive)" }, { "name": "search", "value": "", "type": "query", "description": "Fuzzy search string (case-insensitive substring match)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "keys", "value": "", "type": "query", "description": "Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)" } ] }, "docs": "List distinct actor names from rate limit usage data.\n\nReturns actor names (users and service accounts) ordered by most recently\nseen, with optional fuzzy search filtering.\n\nRequired account permissions: `read:account`" } ] }, { "info": { "name": "Workspace Rate Limit Allocations", "type": "folder" }, "items": [ { "info": { "name": "Read Workspace Rate Limit Allocations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limit-allocations/", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get all rate limit allocations for the account.\n\nRequired account permissions: `read:account`" }, { "info": { "name": "Upsert Workspace Rate Limit Allocations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/rate-limit-allocations/", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert all workspace rate limit allocations for the account.\n\nAll workspaces in the account must be included in the allocations list,\nor an empty list to clear all allocations.\n\nRequired account permissions: `update:account`" } ] }, { "info": { "name": "Workspace Invitations", "type": "folder" }, "items": [ { "info": { "name": "Create Workspace Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/invitations/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite a user to a workspace.\nAny PENDING invitations for the same user to the workspace will be revoked.\n\nRequired account permissions: `create:workspace_invitation`" }, { "info": { "name": "Read Workspace Invitation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/invitations/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get an invitation by id\n\nRequired account permissions: `read:workspace_invitation`" }, { "info": { "name": "Read Workspace Invitations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/invitations/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for invitations\n\nRequired account permissions: `read:workspace_invitation`" }, { "info": { "name": "Revoke Workspace Invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/invitations/:id/revoke", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete an invitation by id\n\nRequired account permissions: `update:workspace_invitation`" } ] }, { "info": { "name": "Workspace User Access", "type": "folder" }, "items": [ { "info": { "name": "Upsert Workspace User Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/user_access/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert a workspace user access\n\nRequired workspace scopes: `manage_workspace_users`" }, { "info": { "name": "Read Workspace User Accesses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/user_access/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for workspace user accesses\n\nRequired workspace scopes: `see_workspace_users`" }, { "info": { "name": "Read Workspace User Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/user_access/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read a workspace user access\n\nRequired workspace scopes: `see_workspace_users`" }, { "info": { "name": "Delete Workspace User Access", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/user_access/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete a workspace user access by id.\n\nThis route will also conditionally delete the user's account membership if:\n- account membership of the actor has `Collaborator` role\n- the actor has no more workspace accesses under the account\n\nRequired workspace scopes: `manage_workspace_users`" } ] }, { "info": { "name": "Workspace Bot Access", "type": "folder" }, "items": [ { "info": { "name": "Upsert Workspace Bot Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/bot_access/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more bots access to a workspace\n\nRequired workspace scopes: `manage_workspace_service_accounts`" }, { "info": { "name": "Read Workspace Bot Accesses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/bot_access/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for workspace bot accesses\n\nRequired workspace scopes: `see_workspace_service_accounts`" }, { "info": { "name": "Read Workspace Bot Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/bot_access/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read a workspace bot access\n\nRequired workspace scopes: `see_workspace_service_accounts`" }, { "info": { "name": "Delete Workspace Bot Access", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/bot_access/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete a workspace bot access by id.\n\nRequired workspace scopes: `manage_workspace_service_accounts`" } ] }, { "info": { "name": "Workspace Team Access", "type": "folder" }, "items": [ { "info": { "name": "Upsert Workspace Team Access", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/team_access/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more teams access to a workspace\n\nRequired workspace scopes: `manage_workspace_teams`" }, { "info": { "name": "Read Workspace Team Accesses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/team_access/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List teams with access to a workspaces\n\nRequired workspace scopes: `manage_workspace_teams`" }, { "info": { "name": "Remove Workspace Team Access", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/team_access/:team_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "Remove a team's access to a workspace\n\nRequired workspace scopes: `manage_workspace_teams`" } ] }, { "info": { "name": "Workspace Access", "type": "folder" }, "items": [ { "info": { "name": "Read Actor Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/access/", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Return a list of all actors with access to the workspace, including\nactors granted access via team membership.\n\nRequired workspace scopes: `see_workspace_users`,`see_workspace_service_accounts`" } ] }, { "info": { "name": "Me", "type": "folder" }, "items": [ { "info": { "name": "Read My Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/" }, "docs": "List the current actor's user profile" }, { "info": { "name": "Read My Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/sessions" }, "docs": "List the current actor's user sessions" }, { "info": { "name": "Filter My Sessions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/me/sessions/filter", "body": { "type": "json", "data": "{}" } }, "docs": "Filter the current actor's user sessions" }, { "info": { "name": "Terminate My Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/me/sessions/:session_id/terminate", "params": [ { "name": "session_id", "value": "", "type": "path" } ] }, "docs": "Terminate the current actor's user session" }, { "info": { "name": "Read My Api Keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/api_keys", "params": [ { "name": "name", "value": "", "type": "query" } ] }, "docs": "List the current actor's api keys" }, { "info": { "name": "Filter My Api Keys", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/me/api_keys/filter", "body": { "type": "json", "data": "{}" } }, "docs": "Filter My Api Keys" }, { "info": { "name": "Read My Accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/accounts" }, "docs": "List the current actor's accounts" }, { "info": { "name": "Read My Organizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/organizations" }, "docs": "List the current actor's accounts that have plans that\nare schemas.plans.AccountPlanType.ORGANIZATION" }, { "info": { "name": "Read My Account Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/accounts/:account_id/permissions", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List the current actor's permissions for the given account" }, { "info": { "name": "Read My Accounts With Permission", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/accounts/has_permission", "params": [ { "name": "permission", "value": "", "type": "query" } ] }, "docs": "Return the account ids the current actor has access to\nfor which they have the given permission" }, { "info": { "name": "Check My Account Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/accounts/:account_id/has_permission", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "permission", "value": "", "type": "query" } ] }, "docs": "Return if current actor has specific permission for account" }, { "info": { "name": "Leave Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/me/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Removes the user from an account. Will also remove any access the user\nhas to any workspaces under that account." }, { "info": { "name": "Read My Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/workspaces" }, "docs": "List the current actor's workspaces" }, { "info": { "name": "Read My Workspace Scopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/workspaces/:workspace_id/scopes", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "List the current actor's scopes for the given workspace" }, { "info": { "name": "Check My Workspace Scopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/me/workspaces/:workspace_id/has_scope", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query" } ] }, "docs": "Return if current actor has specific scope for workspace." }, { "info": { "name": "Leave Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/me/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Removes the user from a workspace.\n\nThis route will also conditionally delete the user's account membership if:\n - account membership of the actor has `Collaborator` role\n - the actor has no more workspace accesses under the account" }, { "info": { "name": "Upload My Profile Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/me/profile-image", "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload My Profile Image" }, { "info": { "name": "Delete My Profile Image", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/me/profile-image" }, "docs": "Delete My Profile Image" }, { "info": { "name": "Reset My Profile Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/me/profile-image/reset" }, "docs": "Reset My Profile Image" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Read User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a user by id." }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user by id." }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a user by id." }, { "info": { "name": "Read User Api Keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:id/api_keys", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "List all APIKeys for a user" }, { "info": { "name": "Create User Api Key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:id/api_keys", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an APIKey for a user" }, { "info": { "name": "Read User Api Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:id/api_keys/:api_key_id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "api_key_id", "value": "", "type": "path" } ] }, "docs": "Read an APIKey for a user" }, { "info": { "name": "Delete User Api Key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/users/:id/api_keys/:api_key_id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "api_key_id", "value": "", "type": "path" } ] }, "docs": "Delete an APIKey for a user" } ] }, { "info": { "name": "Account Billing", "type": "folder" }, "items": [ { "info": { "name": "Get Billing Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/billing/:account_id/details", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the billing details for an account.\n\nRequired account permissions: `read:billing`" }, { "info": { "name": "Get Subscription Restrictions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/billing/:account_id/subscription_restrictions", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns billing restrictions for an account based on current usage.\n\nRequired account permissions: `read:billing`" }, { "info": { "name": "Cancel Org Subscription At Period End", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/cancel_org_subscription", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired account permissions: `update:billing`" }, { "info": { "name": "Update Slots", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/update_slots", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired account permissions: `update:billing`" }, { "info": { "name": "Create Billing Portal Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/create_billing_portal_session", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a billing portal session for an account.\n\nRequired account permissions: `update:billing`" }, { "info": { "name": "Validate Subscription Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/validate_subscription_status", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate an account's subscription has been updated to reflect the latest stripe\nsession.\n\nRequired account permissions: `update:billing`" }, { "info": { "name": "Get Checkout Link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/subscribe", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired account permissions: `update:billing`" }, { "info": { "name": "Manage Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/billing/:account_id/manage_subscription", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Stripe customer portal session for managing an existing subscription.\n\nThis endpoint allows users to update, cancel, or otherwise manage their subscription\nthrough Stripe's customer portal with specific configuration options.\n\nRequired account permissions: `update:billing`" } ] }, { "info": { "name": "Collections", "type": "folder" }, "items": [ { "info": { "name": "Read View Content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/collections/views/:view", "params": [ { "name": "view", "value": "", "type": "path" } ] }, "docs": "Reads the content of a view from the prefect-collection-registry." }, { "info": { "name": "Read Available Work Pool Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/collections/work_pool_types", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Reads the content of a view from the prefect-collection-registry.\n\nRequired workspace scopes: `see_work_pools`" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Create Account Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/events", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Record a batch of Events for an Account" }, { "info": { "name": "Read Account Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/events/filter", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queries for Events matching the given filter criteria in the given Account. Returns\nthe first page of results, and the URL to request the next page (if there are more\nresults)." }, { "info": { "name": "Read Account Events Page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/events/filter/next", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page-token", "value": "", "type": "query" } ] }, "docs": "Returns the next page of Events for a previous query against the given Account, and\nthe URL to request the next page (if there are more results)." }, { "info": { "name": "Count Account Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/events/count-by/:countable", "params": [ { "name": "countable", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns distinct objects and the count of events associated with them. Objects\nthat can be counted include the day the event occurred, the type of event, the\nworkspace, or the IDs of the resources associated with the event." }, { "info": { "name": "Create Workspace Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/events", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Record a batch of Events for one Workspace within an Account" }, { "info": { "name": "Read Workspace Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/events/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queries for Events matching the given filter criteria in the given Account and\nWorkspace. Returns the first page of results, and the URL to request the next\npage (if there are more results)." }, { "info": { "name": "Read Workspace Events Page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/events/filter/next", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "page-token", "value": "", "type": "query" } ] }, "docs": "Returns the next page of Events for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results)." }, { "info": { "name": "Count Workspace Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/events/count-by/:countable", "params": [ { "name": "countable", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns distinct objects and the count of events associated with them. Objects\nthat can be counted include the day the event occurred, the type of event, the\nworkspace, or the IDs of the resources associated with the event." }, { "info": { "name": "Get Events For Flow Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:flow_run_id/events", "headers": [ { "name": "if-none-match", "value": "" } ], "params": [ { "name": "flow_run_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "with_task_runs", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided." } ] }, "docs": "Returns the first page of Events for a flow run against the given Account and Workspace.\n\nIf the `if-none-match` header is provided with the value of the current event count,\nthe server will return a 304 Not Modified response since the client already has the\nlatest events." }, { "info": { "name": "List Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/tags", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query", "description": "A string to search for in the tag names" }, { "name": "page", "value": "", "type": "query", "description": "The page number of tags to return." }, { "name": "sort", "value": "", "type": "query", "description": "Sort tags by name (A→Z or Z→A) or recency (most/least recently seen first)" }, { "name": "limit", "value": "", "type": "query", "description": "Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided." } ] }, "docs": "Page through tags in a workspace." }, { "info": { "name": "Delete Workspace Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/tags", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "tag", "value": "", "type": "query", "description": "The tag name" } ] }, "docs": "Delete a tag from the workspace tags index." } ] }, { "info": { "name": "Resources", "type": "folder" }, "items": [ { "info": { "name": "Read Resources Hierarchy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/hierarchy/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Resources Hierarchy" }, { "info": { "name": "Filter Workspace Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns resources matching the filter referenced in events during\nthe specified time period." }, { "info": { "name": "Read Resources Page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/filter/next", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "page-token", "value": "", "type": "query" } ] }, "docs": "Returns the next page of Resources for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results)." }, { "info": { "name": "Get Filtered Resources Count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/filter/count", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Filtered Resources Count" }, { "info": { "name": "Filter Related Workspace Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/related", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns resources that interacted with resources matching the filter during\nthe specified time period." }, { "info": { "name": "Read Related Resources Page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/related/next", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "page-token", "value": "", "type": "query" } ] }, "docs": "Returns the next page of Resources for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results)." }, { "info": { "name": "Get Related Resources Count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/related/count", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Related Resources Count" }, { "info": { "name": "Get Hidden Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/hidden-resources", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get Hidden Resources" }, { "info": { "name": "Hide Resource Path", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/hidden-resources/add", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Hide Resource Path" }, { "info": { "name": "Remove Resource Exclusion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/resources/hidden-resources/delete", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Resource Exclusion" } ] }, { "info": { "name": "Automations", "type": "folder" }, "items": [ { "info": { "name": "Create Automation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Automation" }, { "info": { "name": "Read Automation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Read Automation" }, { "info": { "name": "Update Automation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/:id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Automation" }, { "info": { "name": "Patch Automation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/:id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch Automation" }, { "info": { "name": "Delete Automation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/:id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Automation" }, { "info": { "name": "Read Automations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Automations" }, { "info": { "name": "Count Automations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/count", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Count Automations" }, { "info": { "name": "Read Automations Related To Resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/related-to/:resource_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "resource_id", "value": "", "type": "path" } ] }, "docs": "Read Automations Related To Resource" }, { "info": { "name": "Delete Automations Owned By Resource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/owned-by/:resource_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "resource_id", "value": "", "type": "path" } ] }, "docs": "Delete Automations Owned By Resource" }, { "info": { "name": "Validate Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/templates/validate", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate Template" } ] }, { "info": { "name": "Managed Automations", "type": "folder" }, "items": [ { "info": { "name": "List Managed Automations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/managed/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "List Managed Automations" }, { "info": { "name": "Create Or Update Managed Automation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/managed/:automation_type", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "automation_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Or Update Managed Automation" }, { "info": { "name": "Delete Managed Automation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/managed/:automation_type", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "automation_type", "value": "", "type": "path" } ] }, "docs": "Delete Managed Automation" }, { "info": { "name": "List Managed Automation Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/automations/managed/types", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "List Managed Automation Types" }, { "info": { "name": "List Managed Automations By Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/managed-automations/", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List Managed Automations By Workspace" }, { "info": { "name": "Delete All Managed Automations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/managed-automations", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete All Managed Automations" }, { "info": { "name": "Quick Enable Managed Automations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/managed-automations/quick-enable", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Enable all managed automations across every workspace in the account.\n\nCurrently enables zombie-cleanup and stuck-cancelling with their default\nsettings. Enqueues a fan-out docket task; individual workspaces are\nprocessed asynchronously." } ] }, { "info": { "name": "SLAs", "type": "folder" }, "items": [ { "info": { "name": "Create Sla", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Sla" }, { "info": { "name": "Apply Slas", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/apply-resource-slas/:resource_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "resource_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply Slas" }, { "info": { "name": "Read Slas", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "sort", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Slas" }, { "info": { "name": "Read Slas By Owner Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/by-owner/:owner_resource", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "owner_resource", "value": "", "type": "path" }, { "name": "sort", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Slas By Owner Resource" }, { "info": { "name": "Read Sla", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/:sla_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "sla_id", "value": "", "type": "path" } ] }, "docs": "Read Sla" }, { "info": { "name": "Update Sla", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/:sla_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "sla_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Sla" }, { "info": { "name": "Delete Sla", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/:sla_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "sla_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Sla" }, { "info": { "name": "Read Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/flow-runs", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read all flow runs that have an SLA violation event within the given horizon.\n\nArgs:\n sla_ids (list[UUID]): The IDs of the SLAs to read flow runs for.\n since (datetime): The date to read flow runs since.\n workspace_id (UUID, optional): The ID of the workspace to read flow runs for. Defaults to Path(...).\n account_id (UUID, optional): The ID of the account to read flow runs for. Defaults to Path(...).\n client (AsyncClient, optional): The ClickHouse client to use. Defaults to Depend" }, { "info": { "name": "Create Default Sla", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/default", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Default Sla" }, { "info": { "name": "Read Default Sla List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/default/list", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read Default Sla List" }, { "info": { "name": "Read Default Sla", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/default/:sla_severity", "params": [ { "name": "sla_severity", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read Default Sla" }, { "info": { "name": "Delete Default Sla", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/slas/default/:sla_severity", "params": [ { "name": "sla_severity", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Default Sla" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Create Webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Webhook" }, { "info": { "name": "Read Webhook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read Webhook" }, { "info": { "name": "Update Webhook", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/:webhook_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Webhook" }, { "info": { "name": "Partial Update Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/:webhook_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partial Update Webhook" }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete Webhook" }, { "info": { "name": "Query Webhooks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/filter", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query Webhooks" }, { "info": { "name": "Rotate Webhook Slug", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/webhooks/:webhook_id/rotate", "params": [ { "name": "webhook_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Rotate Webhook Slug" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Validate Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/templates/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validate Template" }, { "info": { "name": "Health Check", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/health" }, "docs": "Health Check" } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Read Prefect Metric Timeseries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/metrics/prefect/:metric/timeseries", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Prefect Metric Timeseries" }, { "info": { "name": "Read Prefect Metric Timeseries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/metrics/prefect/:metric", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Prefect Metric Timeseries" }, { "info": { "name": "Read Prefect Metric Grouped", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/metrics/prefect/:metric/grouped", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read Prefect Metric Grouped" }, { "info": { "name": "Read Flow Run Resource Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/metrics/flow-runs/:flow_run_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "flow_run_id", "value": "", "type": "path", "description": "The flow run ID" }, { "name": "metric_names", "value": "", "type": "query", "description": "Filter to specific metric names" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of time range filter" }, { "name": "end_time", "value": "", "type": "query", "description": "End of time range filter" } ] }, "docs": "Get resource metrics (CPU, memory, etc.) for a specific flow run.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Deployment Resource Peaks Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/metrics/deployments/:deployment_id/resource-peaks", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The deployment ID" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of time range filter" }, { "name": "end_time", "value": "", "type": "query", "description": "End of time range filter" } ] }, "docs": "Get peak resource metrics across all flow runs for a deployment.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "List Available Flow Run Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/metrics/flow-runs/:flow_run_id/names", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "flow_run_id", "value": "", "type": "path", "description": "The flow run ID" } ] }, "docs": "List the distinct metric names available for a flow run.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List Assets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "prefix", "value": "", "type": "query", "description": "Prefix to search assets keys for" }, { "name": "search", "value": "", "type": "query", "description": "Substring to search assets keys for" } ] }, "docs": "List Assets" }, { "info": { "name": "Read Asset", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/key", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query" } ] }, "docs": "Read Asset" }, { "info": { "name": "Delete Asset", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/key", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query" } ] }, "docs": "Delete Asset" }, { "info": { "name": "Latest Dependencies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/latest-dependencies", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Latest Dependencies" }, { "info": { "name": "Get Asset Neighbors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/neighbors", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query", "description": "The asset key to get neighbors for" } ] }, "docs": "Get the direct (1-hop) neighbors of a specific asset.\n\nReturns the asset, its immediate upstream and downstream dependencies,\nand the dependency edges between them. Does not traverse transitive\ndependencies." }, { "info": { "name": "Filter Assets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/filter", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Filter Assets" }, { "info": { "name": "Filter Assets Page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/filter/next", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "page-token", "value": "", "type": "query" } ] }, "docs": "Filter Assets Page" }, { "info": { "name": "List Asset Materializations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/materializations", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query", "description": "The asset key to get materializations for" }, { "name": "since", "value": "", "type": "query", "description": "Only return materializations on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return materializations on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order: 'asc' or 'desc'" } ] }, "docs": "Get historical materializations for a specific asset.\n\nReturns one materialization per run (deduplicated by run_id, latest occurred wins)." }, { "info": { "name": "List Asset References", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/references", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query", "description": "The asset key to get references for" }, { "name": "since", "value": "", "type": "query", "description": "Only return references on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return references on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order: 'asc' or 'desc'" } ] }, "docs": "Get downstream assets that reference (consume) a specific asset.\n\nReturns materializations of assets that have the queried asset in their\nupstream dependencies. Deduplicated by run_id (latest occurred wins)." }, { "info": { "name": "Read Asset Materialization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/materializations/:event_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path", "description": "The event ID of the materialization" }, { "name": "key", "value": "", "type": "query", "description": "The asset key for validation" } ] }, "docs": "Get a specific materialization event by its event ID.\n\nThe asset key must be provided and match the event's asset key." }, { "info": { "name": "Get Upstream Materializations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/materializations/:event_id/upstream", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path", "description": "The event ID of the focal materialization" }, { "name": "key", "value": "", "type": "query", "description": "The asset key of the focal materialization" } ] }, "docs": "Get the latest materialization of each upstream asset that occurred\nbefore a specific materialization event." }, { "info": { "name": "Read Asset Reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/assets/references/:event_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path", "description": "The event ID of the downstream consumer" }, { "name": "key", "value": "", "type": "query", "description": "The upstream asset key being referenced" } ] }, "docs": "Get a specific downstream consumer by its event ID.\n\nReturns the materialization event for an asset that consumes the queried upstream\nasset. The upstream asset key must be provided and must appear in the\nmaterialization's upstream dependencies." } ] }, { "info": { "name": "Available Assets", "type": "folder" }, "items": [ { "info": { "name": "List Available Assets Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/available-assets/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List Available Assets Endpoint" } ] }, { "info": { "name": "Event Publications", "type": "folder" }, "items": [ { "info": { "name": "List Publications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "resource_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List Publications" }, { "info": { "name": "Create Publication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Publication" }, { "info": { "name": "Read Publication", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/:publication_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "publication_id", "value": "", "type": "path" } ] }, "docs": "Read Publication" }, { "info": { "name": "Update Publication", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/:publication_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "publication_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Publication" }, { "info": { "name": "Delete Publication", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/:publication_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "publication_id", "value": "", "type": "path" } ] }, "docs": "Delete Publication" }, { "info": { "name": "List Publication Subscribers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-publications/:publication_id/subscriptions", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "publication_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List Publication Subscribers" } ] }, { "info": { "name": "Event Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-subscriptions/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "resource_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List Subscriptions" }, { "info": { "name": "Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-subscriptions/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Subscription" }, { "info": { "name": "Read Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-subscriptions/:subscription_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "subscription_id", "value": "", "type": "path" } ] }, "docs": "Read Subscription" }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-subscriptions/:subscription_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "subscription_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Subscription" }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/event-subscriptions/:subscription_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "subscription_id", "value": "", "type": "path" } ] }, "docs": "Delete Subscription" } ] }, { "info": { "name": "Asset Publications", "type": "folder" }, "items": [ { "info": { "name": "Create Asset Publication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/asset-publications/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Asset Publication" } ] }, { "info": { "name": "Asset Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Create Asset Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/asset-subscriptions/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Asset Subscription" } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Create Logs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/logs/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new logs from the provided schema.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Read Logs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/logs/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for logs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Get Flow Run Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/logs", "headers": [ { "name": "if-none-match", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "level_ge", "value": "", "type": "query" }, { "name": "level_le", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query", "description": "Only include logs with a timestamp at or after this time" }, { "name": "until", "value": "", "type": "query", "description": "Only include logs with a timestamp at or before this time" }, { "name": "task_runs", "value": "", "type": "query", "description": "Comma-separated list of task run IDs to filter by" }, { "name": "task_runs_is_null", "value": "", "type": "query", "description": "If true, only include logs without a task run ID" }, { "name": "loggers", "value": "", "type": "query", "description": "Comma-separated list of logger names to filter by" }, { "name": "text_query", "value": "", "type": "query", "description": "Text search query string" }, { "name": "limit", "value": "", "type": "query", "description": "Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided." } ] }, "docs": "Returns a page of logs for a flow run\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Download Flow Run Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/download-logs-csv", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" } ] }, "docs": "Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Download Flow Run Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/logs/download", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" } ] }, "docs": "Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Trace Observed Loggers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/observed-loggers", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace ID to query observed loggers for" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for logger names" }, { "name": "order_by", "value": "", "type": "query", "description": "Order results by name (alphabetically) or recency (most recently seen first)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Get observed logger names used in a specific trace.\n\nReturns distinct logger names used in the trace with their usage counts\nand first/last seen timestamps. Useful for showing what loggers were\nactive in a flow run and providing autocomplete/filtering options.\n\nArgs:\n workspace_id: The workspace ID\n trace_id: The trace (flow run) ID to analyze\n query: Optional prefix search on logger name\n order_by: Order by name (alphabetically) or recency (most recent first)\n limit: Maximum numb" }, { "info": { "name": "Read Workspace Observed Loggers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/observed-loggers", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for logger names" }, { "name": "order_by", "value": "", "type": "query", "description": "Order results by name (alphabetically) or recency (most recently seen first)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Get observed logger names for a workspace.\n\nReturns distinct logger names across all traces in the workspace.\nResults are filtered by workspace retention policy.\nUseful for providing autocomplete/filtering options in the UI.\n\nArgs:\n account_id: The account ID\n workspace_id: The workspace ID\n query: Optional prefix search on logger name\n order_by: Order by name (alphabetically) or recency (most recent first)\n limit: Maximum number of results\n\nReturns:\n List of ObservedLogger obj" } ] }, { "info": { "name": "AI", "type": "folder" }, "items": [ { "info": { "name": "Summarize Flow Run Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/logs/ai/flow_run_logs/:flow_run_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "flow_run_id", "value": "", "type": "path" } ] }, "docs": "Summarize error logs for a flow run.\n\nIf the `flow_run_id` is not found, or if there are no error logs for the\nflow run, the `result` will be `None`.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Artifacts", "type": "folder" }, "items": [ { "info": { "name": "Create Artifact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_artifacts`" }, { "info": { "name": "Read Artifact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the artifact to retrieve." }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Retrieve an artifact from the database.\n\nRequired workspace scopes: `see_artifacts`" }, { "info": { "name": "Update Artifact", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the artifact to update." }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an artifact in the database.\n\nRequired workspace scopes: `write_artifacts`" }, { "info": { "name": "Delete Artifact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the artifact to delete." }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete an artifact from the database.\n\nRequired workspace scopes: `manage_artifacts`" }, { "info": { "name": "Read Latest Artifact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/:key/latest", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the artifact to retrieve." }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the latest artifact from the database.\n\nRequired workspace scopes: `see_artifacts`" }, { "info": { "name": "Read Artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`" }, { "info": { "name": "Read Latest Artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/latest/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`" }, { "info": { "name": "Count Artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count artifacts in the database.\n\nRequired workspace scopes: `see_artifacts`" }, { "info": { "name": "Count Latest Artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/artifacts/latest/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`" } ] }, { "info": { "name": "Flows", "type": "folder" }, "items": [ { "info": { "name": "Create Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gracefully creates a new flow from the provided schema. If a flow with the\nsame name already exists, the existing flow is returned.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Read Flow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a flow by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Update Flow", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a flow.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Delete Flow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow id" } ] }, "docs": "Delete a flow by id.\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Count Flows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count flows.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/name/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The name of the flow" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a flow by name.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for flows.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Bulk Delete Flows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/bulk_delete", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk delete flows using a filter.\n\nThis endpoint soft-deletes flows matching the provided filter criteria,\nthen hard-deletes their associated deployments.\nFlow runs are soft-deleted asynchronously in the background.\nAssociated automations are cleaned up asynchronously in the background.\n\nIf ANY deployment for a flow is unauthorized, the entire request fails\nand nothing is deleted.\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Paginate Flows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flows/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for flows.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Count Deployments By Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flows/count-deployments", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get deployment counts by flow id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Next Runs By Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flows/next-runs", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the next flow run by flow id.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Flow Runs", "type": "folder" }, "items": [ { "info": { "name": "Create Flow Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a flow run. If a flow run with the same flow_id and\nidempotency key already exists, the existing flow run will be returned.\n\nIf no state is provided, the flow run will be created in a PENDING state.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Read Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for flow runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Runs Minimal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/filter-minimal", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flow runs filter that excludes full state data -- and possibly other\ndata in the future -- for improved performance.\n\nNote that the state name, state type, and state ID are all still available.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a flow run by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Update Flow Run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a flow run.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Delete Flow Run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a flow run by id.\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Count Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for flow runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Average Flow Run Lateness", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/lateness", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for average flow-run lateness in seconds.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Flow Run History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/history", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for flow run history data across a given range and interval.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run Graph V1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/graph", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a task run dependency map for a given flow run.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run Graph V2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/graph-v2", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Only include runs that start or end after this time." } ] }, "docs": "Get a graph of the tasks and subflow runs for the given flow run\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Get Flow Run Artifacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/artifacts", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit for recursion (0 = flow run only)" }, { "name": "since", "value": "", "type": "query", "description": "Only return artifacts created on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return artifacts created on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by creation time (asc or desc)" } ] }, "docs": "Get all artifacts created within a flow run, including artifacts from\ntask runs and subflow runs (recursively).\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Resume Flow Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/resume", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume a paused flow run.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Bulk Delete Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/bulk_delete", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk delete flow runs using a filter.\n\nThis endpoint soft-deletes flow runs matching the provided filter criteria.\nFor small numbers of flow runs (5 or fewer), cleanup is performed synchronously.\nFor larger batches, cleanup is queued as a background job.\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Bulk Set Flow Run State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/bulk_set_state", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk set state on flow runs matching a filter.\n\nThis endpoint attempts to set the specified state on all flow runs\nmatching the filter criteria. Each flow run is processed through\norchestration rules (unless force=True), so individual transitions\nmay be accepted, rejected, aborted, or waited.\n\nThe response body contains detailed per-run results indicating\nthe outcome for each flow run.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Set Flow Run State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/set_state", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a flow run state, invoking any orchestration rules.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Create Flow Run Input", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a key/value input for a flow run.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Filter Flow Run Input", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Filter flow run inputs by key prefix\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run Input", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/:key", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "key", "value": "", "type": "path", "description": "The input key" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Create a value from a flow run input\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Delete Flow Run Input", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/:key", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "key", "value": "", "type": "path", "description": "The input key" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete a flow run input\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Paginate Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for flow runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Update Flow Run Labels", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/labels", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Get Flow Run Materializations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/assets/materializations", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)." }, { "name": "since", "value": "", "type": "query", "description": "Only return materializations on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return materializations on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by occurred time (asc or desc)" } ] }, "docs": "Get all asset materializations within a flow run, including materializations\nfrom descendant task runs and subflow runs.\n\nReturns a historical snapshot of materializations as they occurred, with asset\nproperties captured at materialization time (not current state).\n\nRequired workspace scopes: `see_assets`" }, { "info": { "name": "Get Flow Run References", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/assets/references", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The flow run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)." }, { "name": "since", "value": "", "type": "query", "description": "Only return references on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return references on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by occurred time (asc or desc)" } ] }, "docs": "Get all asset references within a flow run, including references from\ndescendant task runs and subflow runs.\n\nReturns a historical snapshot of asset references as they occurred, with asset\nproperties captured at reference time (not current state).\n\nRequired workspace scopes: `see_assets`" }, { "info": { "name": "Read Flow Run History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/history", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run History V2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/history-v2", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Count Task Runs By Flow Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/count-task-runs", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get task run counts by flow run id.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Task Runs", "type": "folder" }, "items": [ { "info": { "name": "Read Task Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for task runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Task Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a task run by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Update Task Run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a task run.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Delete Task Run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a task run by id.\n\nRequired workspace scopes: `manage_flows`" }, { "info": { "name": "Create Task Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a task run. If a task run with the same flow_run_id,\ntask_key, and dynamic_key already exists, the existing task\nrun will be returned.\nIf no state is provided, the task run will be created in a PENDING state.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Count Task Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count task runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Task Run History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/history", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for task run history data across a given range and interval.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Get Task Run Artifacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id/artifacts", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit for recursion (0 = task run only)" }, { "name": "since", "value": "", "type": "query", "description": "Only return artifacts created on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return artifacts created on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by creation time (asc or desc)" } ] }, "docs": "Get all artifacts created within a task run, including artifacts from\nsubflow runs spawned by this task (recursively).\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Get Task Run Materializations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id/assets/materializations", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default)." }, { "name": "since", "value": "", "type": "query", "description": "Only return materializations on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return materializations on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by occurred time (asc or desc)" } ] }, "docs": "Get all asset materializations from a task run, including materializations\nfrom descendant runs.\n\nReturns a historical snapshot of materializations as they occurred, with asset\nproperties captured at materialization time (not current state).\n\nRequired workspace scopes: `see_assets`" }, { "info": { "name": "Get Task Run References", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id/assets/references", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "depth", "value": "", "type": "query", "description": "Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default)." }, { "name": "since", "value": "", "type": "query", "description": "Only return references on or after this timestamp" }, { "name": "until", "value": "", "type": "query", "description": "Only return references on or before this timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order by occurred time (asc or desc)" } ] }, "docs": "Get all asset references from a task run, including references from\ndescendant runs.\n\nReturns a historical snapshot of asset references as they occurred, with asset\nproperties captured at reference time (not current state).\n\nRequired workspace scopes: `see_assets`" }, { "info": { "name": "Set Task Run State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/:id/set_state", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The task run id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a task run state, invoking any orchestration rules.\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Paginate Task Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_runs/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for task runs.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Dashboard Task Run Counts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/task_runs/dashboard/counts", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Task Run Counts By State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/task_runs/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Task Workers", "type": "folder" }, "items": [ { "info": { "name": "Read Task Workers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_workers/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read task workers for a workspace. Optionally filter by task keys.\n\nRequired workspace scopes: `see_workers`" } ] }, { "info": { "name": "Flow Run States", "type": "folder" }, "items": [ { "info": { "name": "Read Flow Run State", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_run_states/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The flow run state id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a flow run state by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Flow Run States", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_run_states/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "flow_run_id", "value": "", "type": "query" } ] }, "docs": "Get states associated with a flow run.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Task Run States", "type": "folder" }, "items": [ { "info": { "name": "Read Task Run State", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_run_states/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The task run state id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a task run state by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Task Run States", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/task_run_states/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "task_run_id", "value": "", "type": "query" } ] }, "docs": "Get states associated with a task run.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Deployments", "type": "folder" }, "items": [ { "info": { "name": "Create Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Branch From Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/branch", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Read Deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a deployment by id.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Update Deployment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Delete Deployment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete a deployment by id.\n\nRequired workspace scopes: `manage_deployments`" }, { "info": { "name": "Read Deployment By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/name/:flow_name/:deployment_name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "flow_name", "value": "", "type": "path", "description": "The name of the flow" }, { "name": "deployment_name", "value": "", "type": "path", "description": "The name of the deployment" } ] }, "docs": "Get a deployment using the name of the flow and the deployment.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Read Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Paginate Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for deployments.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Get Scheduled Flow Runs For Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/get_scheduled_flow_runs", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get scheduled runs for a set of deployments. Used by a runner to poll for work.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Count Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count deployments.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Bulk Delete Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/bulk_delete", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk delete deployments using a filter.\n\nThis endpoint deletes deployments matching the provided filter criteria.\nDeployments are deleted immediately so they disappear from the UI.\nAssociated automations are cleaned up asynchronously in the background.\n\nIf ANY deployment in the filter is unauthorized, the entire request fails\nand nothing is deleted.\n\nRequired workspace scopes: `manage_deployments`" }, { "info": { "name": "Schedule Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/schedule", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedule runs for a deployment. For backfills, provide start/end times in the past.\n\nThis function will generate the minimum number of runs that satisfy the min\nand max times, and the min and max counts. Specifically, the following order\nwill be respected.\n\n - Runs will be generated starting on or after the `start_time`\n - No more than `max_runs` runs will be generated\n - No runs will be generated after `end_time` is reached\n - At least `min_runs` runs will be generated\n - Runs wi" }, { "info": { "name": "Resume Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/resume_deployment", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Resume Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/set_schedule_active", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Pause Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/pause_deployment", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Pause Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/set_schedule_inactive", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Create Flow Run From Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/create_flow_run", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a flow run from a deployment.\n\nAny parameters not provided will be inferred from the deployment's parameters.\nIf tags are not provided, the deployment's tags will be used.\n\nIf no state is provided, the flow run will be created in a SCHEDULED state with\na scheduled start time of NOW.\n\nRequired workspace scopes: `run_deployments`" }, { "info": { "name": "Bulk Create Flow Runs From Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/create_flow_run/bulk", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple flow runs from a deployment in a single request.\n\nEach item in the list uses the same schema as the single create endpoint.\nResults are returned in the same order as the input list.\n\nRequired workspace scopes: `run_deployments`" }, { "info": { "name": "Read Deployment Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read access controls for a deployment.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Set Deployment Access", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set access controls for a deployment.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_deployments`" }, { "info": { "name": "Read Actors Deployment Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/my-access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read access controls for a set of deployments and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Work Queue Check For Deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/work_queue_check", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get list of work-queues that are able to pick up the specified deployment.\n\nThis endpoint is intended to be used by the UI to provide users warnings\nabout deployments that are unable to be executed because there are no work\nqueues that will pick up their runs, based on existing filter criteria. It\nmay be deprecated in the future because there is not a strict relationship\nbetween work queues and deployments." }, { "info": { "name": "Read Deployment Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/schedules", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Create Deployment Schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/schedules", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Update Deployment Schedule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/schedules/:schedule_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "schedule_id", "value": "", "type": "path", "description": "The schedule id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Delete Deployment Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/schedules/:schedule_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "schedule_id", "value": "", "type": "path", "description": "The schedule id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Disable Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/disable", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Set a deployment to disabled. Any auto-scheduled runs still in a Scheduled state will be deleted. No new flow runs can be created until the deployment is enabled.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Enable Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/enable", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The deployment id" } ] }, "docs": "Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`" }, { "info": { "name": "Paginate Deployment Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/versions/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Read Deployment Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/versions/:version_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "version_id", "value": "", "type": "path", "description": "The version id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_deployments`" }, { "info": { "name": "Delete Deployment Version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/versions/:version_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "version_id", "value": "", "type": "path", "description": "The version id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_deployments`" }, { "info": { "name": "Promote Deployment Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/deployments/:id/versions/:version_id/promote", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The deployment id" }, { "name": "version_id", "value": "", "type": "path", "description": "The version id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_deployments`" } ] }, { "info": { "name": "SavedSearches", "type": "folder" }, "items": [ { "info": { "name": "Create Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/saved_searches/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gracefully creates a new saved search from the provided schema.\n\nIf a saved search with the same name already exists, the saved search's fields are\nreplaced.\n\nRequired workspace scopes: `manage_saved_search`" }, { "info": { "name": "Read Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/saved_searches/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The saved search id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a saved search by id.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Delete Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/saved_searches/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The saved search id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Delete a saved search by id.\n\nRequired workspace scopes: `manage_saved_search`" }, { "info": { "name": "Read Saved Searches", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/saved_searches/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for saved searches.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Pins", "type": "folder" }, "items": [ { "info": { "name": "Create User Pin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/pins/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pin a resource for the current user.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read User Pins", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/pins/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List pins for the current user, optionally filtered by resource type.\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Delete User Pin", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/pins/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The pin id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Remove a pin for the current user.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Concurrency Limits", "type": "folder" }, "items": [ { "info": { "name": "Create Concurrency Limit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Read Concurrency Limit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The concurrency limit id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a concurrency limit by id.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Delete Concurrency Limit", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The concurrency limit id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Read Concurrency Limit By Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/tag/:tag", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a concurrency limit by tag.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Delete Concurrency Limit By Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/tag/:tag", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Read Concurrency Limits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for concurrency limits.\n\nFor each concurrency limit the `active slots` field contains a list of TaskRun IDs\ncurrently using a concurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Reset Concurrency Limit By Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/tag/:tag/reset", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Increment Concurrency Limits V1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/increment", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `run_flows`" }, { "info": { "name": "Decrement Concurrency Limits V1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/concurrency_limits/decrement", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `run_flows`" } ] }, { "info": { "name": "Concurrency Limits V2", "type": "folder" }, "items": [ { "info": { "name": "Create Concurrency Limit V2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Read Concurrency Limit V2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/:id_or_name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "The ID or name of the concurrency limit" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Update Concurrency Limit V2", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/:id_or_name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "The ID or name of the concurrency limit" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Delete Concurrency Limit V2", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/:id_or_name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "The ID or name of the concurrency limit" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Read All Concurrency Limits V2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Paginate Concurrency Limits V2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for concurrency limits.\n\nRequired workspace scopes: `see_concurrency_limits`" }, { "info": { "name": "Bulk Increment Active Slots", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/increment", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Bulk Increment Active Slots With Lease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/increment-with-lease", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Bulk Decrement Active Slots", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/decrement", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Bulk Decrement Active Slots With Lease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/decrement-with-lease", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" }, { "info": { "name": "Renew Concurrency Lease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/v2/concurrency_limits/leases/:lease_id/renew", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "lease_id", "value": "", "type": "path", "description": "The ID of the lease to renew" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_concurrency_limits`" } ] }, { "info": { "name": "Block types", "type": "folder" }, "items": [ { "info": { "name": "Create Block Type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new block type\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Type By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block type ID" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a block type by ID.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Update Block Type", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block type ID" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a block type.\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Delete Block Type", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block type ID" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Type By Slug", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/slug/:slug", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "slug", "value": "", "type": "path", "description": "The block type name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Get a block type by name.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Read Block Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets all block types. Optionally limit return with limit and offset.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Read Block Documents For Block Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/slug/:slug/block_documents", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path", "description": "The block type name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Whether to include sensitive values in the block document." } ] }, "docs": "\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Read Block Document By Name For Block Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/slug/:slug/block_documents/name/:block_document_name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path", "description": "The block type name" }, { "name": "block_document_name", "value": "", "type": "path", "description": "The block type name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Whether to include sensitive values in the block document." } ] }, "docs": "\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Install System Block Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_types/install_system_block_types", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" } ] }, { "info": { "name": "Block documents", "type": "folder" }, "items": [ { "info": { "name": "Create Block Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new block document.\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Create Or Update Block Document", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for block documents.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Count Block Documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count block documents.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Read Block Document By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The block document id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Whether to include sensitive values in the block document." } ] }, "docs": "\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Update Block Document Data", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The block document id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Delete Block Document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block document id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Document Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/:id/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block_document id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read access controls for a block_document.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Set Block Document Access", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/:id/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The block_document id" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set access controls for a block document.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Actors Block Document Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_documents/my-access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read access controls for a set of block documents and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_blocks`" } ] }, { "info": { "name": "Variables", "type": "folder" }, "items": [ { "info": { "name": "Create Variable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_variables`" }, { "info": { "name": "Read Variable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_variables`" }, { "info": { "name": "Update Variable", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_variables`" }, { "info": { "name": "Delete Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_variables`" }, { "info": { "name": "Read Variable By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/name/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_variables`" }, { "info": { "name": "Update Variable By Name", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/name/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_variables`" }, { "info": { "name": "Delete Variable By Name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/name/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `manage_variables`" }, { "info": { "name": "Read Variables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_variables`" }, { "info": { "name": "Count Variables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/variables/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `see_variables`" } ] }, { "info": { "name": "Work Pools", "type": "folder" }, "items": [ { "info": { "name": "Preview Work Pool Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/configuration/preview", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview Work Pool Configuration" }, { "info": { "name": "Create Work Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new work pool. If a work pool with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_pools`" }, { "info": { "name": "Read Work Pool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read a work pool by name\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Update Work Pool", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a work pool\n\nRequired workspace scopes: `write_work_pools`" }, { "info": { "name": "Delete Work Pool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a work pool\n\nRequired workspace scopes: `manage_work_pools`" }, { "info": { "name": "Read Work Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read multiple work pools\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Paginate Work Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Paginated query for work pools.\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Count Work Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/count", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count work pools\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Get Scheduled Flow Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/get_scheduled_flow_runs", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work pool name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Load scheduled runs for a worker\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Pool Access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Read access controls for a work_pool.\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Set Work Pool Access", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set access controls for a work_pool.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_work_pools`" }, { "info": { "name": "Read Actors Work Pool Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/my-access", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read access controls for a set of work pools and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_work_pools`" }, { "info": { "name": "Create Work Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new work pool queue. If a work pool queue with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_queues`" }, { "info": { "name": "Read Work Queue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "name", "value": "", "type": "path", "description": "The work pool queue name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read a work pool queue\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Update Work Queue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "name", "value": "", "type": "path", "description": "The work pool queue name" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a work pool queue\n\nRequired workspace scopes: `write_work_queues`" }, { "info": { "name": "Delete Work Queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "name", "value": "", "type": "path", "description": "The work pool queue name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a work pool queue\n\nRequired workspace scopes: `manage_work_queues`" }, { "info": { "name": "Read Work Queues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read all work pool queues\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Paginate Work Queues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for work pool queues\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Worker Heartbeat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/heartbeat", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `write_workers`" }, { "info": { "name": "Read Workers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read all worker processes\n\nRequired workspace scopes: `see_workers`" }, { "info": { "name": "Paginate Workers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read all worker processes\n\nRequired workspace scopes: `see_workers`" }, { "info": { "name": "Read Worker", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/:worker_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "worker_id", "value": "", "type": "path", "description": "The worker process id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Read a single worker process\n\nRequired workspace scopes: `see_workers`" }, { "info": { "name": "Delete Worker", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "work_pool_name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "name", "value": "", "type": "path", "description": "The work pool's worker name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a work pool's worker\n\nRequired workspace scopes: `manage_workers`" }, { "info": { "name": "Read Work Pool Concurrency Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/concurrency_status", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work pool name" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the concurrency status of a work pool, including per-queue breakdown\nand flow run details for each slot holder.\n\nRequired workspace scopes: `see_work_queues`,`see_work_pools`" }, { "info": { "name": "Count Flow Runs By Work Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/work_pools/count-flow-runs", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get flow run counts grouped by work pool id.\n\nReturns a mapping of work_pool_id to the number of flow runs matching the\noptional filter. Work pools with no matching runs are included with a count\nof zero.\n\nRequired workspace scopes: `see_flows`" } ] }, { "info": { "name": "Work Queues", "type": "folder" }, "items": [ { "info": { "name": "Create Work Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new work queue for the default agent work pool.\n\nIf a work queue with the same name already exists, an error\nwill be raised.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Queue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The work queue id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a work queue by id.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Update Work Queue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The work queue id" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing work queue.\n\nRequired workspace scopes: `write_work_queues`" }, { "info": { "name": "Delete Work Queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The work queue id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a work queue by id.\n\nRequired workspace scopes: `manage_work_queues`" }, { "info": { "name": "Read Work Queue By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/name/:name", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path", "description": "The work queue name" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a work queue by id.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Queue Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id/get_runs", "headers": [ { "name": "x-prefect-ui", "value": "" }, { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The work queue id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get flow runs from the work queue.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Queues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query for work queues.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Paginate Work Queues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/paginate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pagination query for work queues.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Queue Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id/status", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The work queue id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get the status of a work queue.\n\nRequired workspace scopes: `see_work_queues`" }, { "info": { "name": "Read Work Queue Concurrency Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_queues/:id/concurrency_status", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The work queue id" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the concurrency status of a work queue, including flow run details\nfor each slot holder.\n\nRequired workspace scopes: `see_work_queues`" } ] }, { "info": { "name": "Block schemas", "type": "folder" }, "items": [ { "info": { "name": "Create Block Schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_schemas/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Schema By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_schemas/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The block schema id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a block schema by id.\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Delete Block Schema", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_schemas/:id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The block schema id" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a block schema by id.\n\nRequired workspace scopes: `manage_blocks`" }, { "info": { "name": "Read Block Schemas", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_schemas/filter", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Read all block schemas, optionally filtered by type\n\nRequired workspace scopes: `see_blocks`" }, { "info": { "name": "Read Block Schema By Checksum", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_schemas/checksum/:checksum", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "checksum", "value": "", "type": "path", "description": "The block schema checksum" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned." } ] }, "docs": "\n\nRequired workspace scopes: `see_blocks`" } ] }, { "info": { "name": "Block capabilities", "type": "folder" }, "items": [ { "info": { "name": "Read Available Block Capabilities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/block_capabilities/", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "\n\nRequired workspace scopes: `see_blocks`" } ] }, { "info": { "name": "Spans", "type": "folder" }, "items": [ { "info": { "name": "Read Spans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace ID to query spans for" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "parent_span_id", "value": "", "type": "query", "description": "Filter by parent span ID (None = all spans)" }, { "name": "depth", "value": "", "type": "query", "description": "Filter by depth level (None = all depths)" }, { "name": "entities", "value": "", "type": "query", "description": "Filter by entity types (e.g., 'flow-run', 'task-run', 'artifact')" }, { "name": "state_types", "value": "", "type": "query", "description": "Filter by state types (e.g., 'COMPLETED', 'RUNNING', 'FAILED')" }, { "name": "state_names", "value": "", "type": "query", "description": "Filter by state names (e.g., 'Completed', 'Running', 'Failed')" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags (OR logic - span matches if it has ANY of the specified tags)" }, { "name": "query", "value": "", "type": "query", "description": "Text search query across span content (space=OR, -/!=NOT, quotes=phrases)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor from previous response" }, { "name": "direction", "value": "", "type": "query", "description": "Pagination direction" } ] }, "docs": "Get spans with cursor-based pagination for efficient browsing.\n\nUse cases:\n- Initial page load (depth=0 for root spans)\n- Expand a node (parent_span_id=X for children)\n- Browse all spans at specific depth\n- Filter by state types/names\n- Paginate through large result sets (both directions)\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Span Context", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/context/:span_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace containing the span" }, { "name": "span_id", "value": "", "type": "path", "description": "The target span to get context for" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "context_size", "value": "", "type": "query", "description": "Number of siblings before/after to include" } ] }, "docs": "Get full context window for detailed span view.\n\nReturns:\n- spans: All ancestors + siblings in context window\n- target_span_id: The requested span ID\n- has_more_before/after: Pagination indicators\n\nUse case: When user clicks on a span or loads a deep link URL\n\nThe frontend receives a flat list of spans and can:\n- Build the tree structure from parent relationships\n- Highlight the target span\n- Show pagination controls based on has_more flags\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Trace Observed States", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/observed-states", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace ID to query observed states for" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for state type or name" }, { "name": "order_by", "value": "", "type": "query", "description": "Order results by name (alphabetically) or recency (most recently seen first)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Get observed state type/name combinations used in a specific trace.\n\nReturns distinct state combinations used in the trace.\nUseful for showing what states were actually used in a flow run and\nproviding autocomplete/filtering options.\n\nArgs:\n workspace_id: The workspace ID\n trace_id: The trace (flow run) ID to analyze\n query: Optional prefix search on state_type or state_name\n order_by: Order by name (alphabetically) or recency (most recent first)\n limit: Maximum number of results\n" }, { "info": { "name": "Read Trace Observed Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/observed-tags", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace ID to query observed tags for" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for tag names" } ] }, "docs": "Get all observed tags and their counts for a specific trace.\n\nReturns all tags used in spans within the trace with their occurrence counts.\nUseful for showing what tags were used in a flow run and their frequency.\n\nArgs:\n workspace_id: The workspace ID\n trace_id: The trace (flow run) ID to analyze\n\nReturns:\n List of ObservedTag objects with tag names and counts\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Single Span", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/spans/:span_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace containing the span" }, { "name": "span_id", "value": "", "type": "path", "description": "The span ID to retrieve" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a single span by ID within a specific trace.\n\nArgs:\n workspace_id: The workspace ID\n trace_id: The trace (flow run) ID containing the span\n span_id: The span ID to retrieve\n\nReturns:\n SpanResponse with has_children and child_count computed\n\nRaises:\n HTTPException: 404 if span not found or doesn't belong to trace\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Spans By Ids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/traces/:trace_id/spans", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "trace_id", "value": "", "type": "path", "description": "The trace containing the spans" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "List of span IDs to retrieve. Only returns spans that exist and belong to the specified trace." } ] }, "docs": "Get multiple spans by IDs within a specific trace.\n\nReturns only spans that exist and belong to the specified trace.\nEmpty IDs list or no matches returns empty list.\n\nArgs:\n workspace_id: The workspace ID\n trace_id: The trace (flow run) ID containing the spans\n ids: List of span IDs to retrieve\n\nReturns:\n List of SpanResponse objects with has_children and child_count computed\n\nRaises:\n HTTPException: 404 if trace doesn't exist\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Lookup Span By Run Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/spans/lookup/:run_id", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path", "description": "The run ID to lookup span information for" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Look up trace and span information for a given run ID.\n\nTreats the run_id as a span_id and returns the trace_id and span_id\nof the found span. This is useful for navigating from a child run ID\nto its trace view.\n\nArgs:\n workspace_id: The workspace ID\n run_id: The run ID to look up (treated as span_id)\n\nReturns:\n SpanIdentifierResponse containing trace_id and span_id\n\nRaises:\n HTTPException: 404 if span not found\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Span Observed Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/spans/:span_id/observed-tags", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "span_id", "value": "", "type": "path", "description": "The span ID to query observed tags for" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for tag names" } ] }, "docs": "Get all observed tags and their counts for a specific span and all its descendants.\n\nUses a recursive query to find all descendant spans, then aggregates tags\nfrom the target span and all its children recursively.\n\nArgs:\n workspace_id: The workspace ID\n span_id: The span ID to analyze (includes this span + all descendants)\n\nReturns:\n List of ObservedTag objects with tag names and occurrence counts\n\nRequired workspace scopes: `see_flows`" }, { "info": { "name": "Read Workspace Observed States", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/observed-states", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "Prefix search query for state type or name" }, { "name": "order_by", "value": "", "type": "query", "description": "Order results by name (alphabetically) or recency (most recently seen first)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Get observed state type/name combinations for a workspace.\n\nReturns distinct state combinations across all traces in the workspace.\nResults are filtered by workspace retention policy.\nUseful for providing autocomplete/filtering options in the UI.\n\nArgs:\n account_id: The account ID\n workspace_id: The workspace ID\n query: Optional prefix search on state_type or state_name\n order_by: Order by name (alphabetically) or recency (most recent first)\n limit: Maximum number of results\n\nRetu" } ] }, { "info": { "name": "UI", "type": "folder" }, "items": [ { "info": { "name": "Validate Obj", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/schemas/validate", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate Obj" }, { "info": { "name": "Validate Schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/schemas/validate_schema", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate Schema" } ] }, { "info": { "name": "Root", "type": "folder" }, "items": [ { "info": { "name": "Hello", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/hello", "headers": [ { "name": "x-prefect-api-version", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Say hello!" } ] } ], "bundled": true }