1. API Reference
  2. API resources
  3. Projects
Website
  • API overview
  • API quickstart
  • Authentication
  • Project scoping
  • Requests and responses
  • Pagination and filtering
  • Errors
  • GETList supported database engines
  • POSTList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEDelete a project
  • PATCHUpdate a project
  • POSTCreate a source
  • POSTList sources
  • GETGet source details
  • DELETEDelete a source
  • PATCHUpdate a source
  • POSTCreate secret metadata
  • POSTList secret metadata
  • GETGet secret metadata
  • DELETEDelete secret metadata
  • PATCHUpdate secret metadata
  • POSTCreate a schedule
  • POSTList schedules
  • POSTSummarize schedule statuses
  • GETGet a schedule
  • DELETEDelete a schedule
  • PATCHUpdate a schedule
  • DELETERemove a schedule gate
  • POSTActivate or pause a schedule
  • POSTQueue a manual check
  • POSTCreate an immutable report
  • POSTList reports
  • GETGet report details
  • DELETEDelete a report
  • POSTDownload a report
  • POSTGet the API-key scope catalog
  • POSTCreate an API key
  • POSTList API-key metadata
  • GETGet API-key metadata
  • DELETEDelete an API key
  • PATCHUpdate API-key metadata
  • POSTCreate a notification channel
  • POSTList notification channels
  • POSTResolve notification channels by ID
  • GETGet notification channel details
  • DELETEDelete a notification channel
  • PATCHUpdate a notification channel
  • POSTSend a test notification
  • POSTCreate a project worker
  • POSTList project workers
  • GETGet worker details
  • DELETEDelete a worker
  • PATCHUpdate a worker
  • POSTRead live worker agent logs
  • POSTList checks
  • POSTSummarize check statuses
  • GETGet check details
  • POSTGet check log sections
  • POSTDownload a check log
  • POSTDownload check audit evidence
  • POSTList notification messages
  • GETGet notification message details

Projects

Understand the session-only project boundary used by every RestoreTrust automation resource.

Loading documentation…

API resources< PreviousSourcesNext >

Powered by heyo

On this page

Project fieldsEndpoint reference

A project is the isolation boundary for API keys, workers, schedules, checks, and related resources.

Interactive session required

Project endpoints do not accept X-API-Key. Create and manage projects through the RestoreTrust console or a console-managed user session.

Project fields

namestringrequired

Display name, 1–120 characters.

org_idstringrequired

Owning organization. Required when creating a project.

environment"development" | "staging" | "production"optional

Project environment label; defaults to production.

abbrstringoptional

Optional 1–3 character uppercase abbreviation using A–Z and 0–9.

Endpoint reference

  • List projects
  • Create a project
  • Get a project
  • Update a project
  • Delete a project

Project access is inherited from organization membership.

Related topics

  • Apply project scoping to API-key calls
  • Organizations and projects
  • Create API keys for a project