/
RI
rilldata
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
post
/v1/ai/complete
Complete sends the messages of a chat to the AI and asks it to generate a new message.
post
/v1/billing/metrics-project-credentials
GetBillingProjectCredentials returns credentials for the configured cloud metrics project filtered by request organization
get
/v1/billing/plans
ListPublicBillingPlans lists all public billing plans
post
/v1/deployments/-/connector-oauth-token
GetConnectorOAuthToken returns a user's OAuth access token for a connector in the calling deployment's project, refreshing it first if it is about to expire. It returns NotFound if the user has not authorized the connector's current OAuth configuration. It can only be called by deployments.
post
/v1/deployments/-/connector-oauth-token/delete
DeleteConnectorOAuthToken removes a user's OAuth authorization for a connector in the calling deployment's project. It can only be called by deployments.
delete
/v1/deployments/{deploymentId}
DeleteDeployment deletes a deployment.
get
/v1/deployments/{deploymentId}/config
GetDeploymentConfig returns the configuration for a deployment that the runtime should apply. This is called by the runtime to pull its Variables and Annotations from the admin service.
post
/v1/deployments/{deploymentId}/credentials
GetDeployment returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes
post
/v1/deployments/{deploymentId}/provision
Provision provisions a new resource for a deployment. If an existing resource matches the request, it will be returned without provisioning a new resource.
post
/v1/deployments/{deploymentId}/reconcile
TriggerReconcile triggers reconcile for the project's prod deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post
/v1/deployments/{deploymentId}/refresh
TriggerRefreshSources refresh the source for production deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post
/v1/deployments/{deploymentId}/start
StartDeployment starts a deployment.
post
/v1/deployments/{deploymentId}/stop
StopDeployment stops a deployment.
get
/v1/github/repositories
GetGithubRepoRequest returns info about a Github repo based on the caller's installations. If the caller has not granted access to the repository, instructions for granting access are returned.
get
/v1/github/user
GetGithubUserStatus returns info about a Github user account based on the caller's installations. If we don't have access to user's personal account tokens or it is expired, instructions for granting access are returned.
get
/v1/github/user/repositories
delete
/v1/magic-tokens/{tokenId}
RevokeMagicAuthToken revokes a magic auth token.
get
/v1/magic-tokens/current
GetCurrentMagicAuthToken returns information about the current magic auth token.
get
/v1/organization-for-domain/{domain}
GetOrganizationNameForDomain finds the org name for a custom domain. If the application detects it is running on a non-default domain, it can use this to find the org to present. It can be called without being authenticated.
get
/v1/orgs
ListOrganizations lists all the organizations currently managed by the admin
post
/v1/orgs
CreateOrganization creates a new organization
get
/v1/orgs/{org}
GetOrganization returns information about a specific organization
delete
/v1/orgs/{org}
DeleteOrganization deletes an organization
patch
/v1/orgs/{org}
UpdateOrganization updates an organization
get
/v1/orgs/{org}/billing/credits
GetBillingCreditBalance returns the organization's remaining trial credit balance
get
/v1/orgs/{org}/billing/issues
ListOrganizationBillingIssues lists all the billing issues for the organization
get
/v1/orgs/{org}/billing/payments/portal-url
GetPaymentsPortalURL returns the URL for the billing session to collect payment method
get
/v1/orgs/{org}/billing/subscriptions
GetBillingSubscription lists the subscription for the organization
delete
/v1/orgs/{org}/billing/subscriptions
CancelBillingSubscription cancels the billing subscription for the organization
patch
/v1/orgs/{org}/billing/subscriptions
UpdateBillingSubscription updates the billing plan for the organization
post
/v1/orgs/{org}/billing/subscriptions/renew
RenewBillingSubscription renews the billing plan for the organization once cancelled
put
/v1/orgs/{org}/create-managed-git-repo
CreateManagedGitRepo creates a new rill managed git repo for the organization.
post
/v1/orgs/{org}/create_asset
CreateAsset returns a one time signed URL using which any asset can be uploaded.
get
/v1/orgs/{org}/invites
ListOrganizationInvites lists all the org invites
get
/v1/orgs/{org}/members
ListOrganizationMemberUsers lists all the org members
post
/v1/orgs/{org}/members
AddOrganizationMemberUser adds a user to the organization
get
/v1/orgs/{org}/members/{email}
GetOrganizationMemberUser gets the member details
put
/v1/orgs/{org}/members/{email}
SetOrganizationMemberUserRole sets the role for the member
delete
/v1/orgs/{org}/members/{email}
RemoveOrganizationMemberUser removes member from the organization
put
/v1/orgs/{org}/members/{email}/attributes
UpdateOrganizationMemberUserAttributes updates the attributes for a member
delete
/v1/orgs/{org}/members/current
LeaveOrganization removes the current user from the organization
get
/v1/orgs/{org}/projects
ListProjectsForOrganization lists all the projects currently available for a given organization.
post
/v1/orgs/{org}/projects
CreateProject creates a new project
get
/v1/orgs/{org}/projects-for-user
ListProjectsForOrganizationAndUser lists all the projects that an organization member user has access to. It does not include projects that the user has access to through a usergroup.
get
/v1/orgs/{org}/projects/{project}
GetProject returns information about a specific project
delete
/v1/orgs/{org}/projects/{project}
DeleteProject deletes a project
patch
/v1/orgs/{org}/projects/{project}
UpdateProject updates a project
post
/v1/orgs/{org}/projects/{project}/alerts
CreateAlert adds a virtual file for an alert, triggers a reconcile, and waits for the alert to be added to the runtime catalog
post
/v1/orgs/{org}/projects/{project}/alerts/-/yaml
GenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
put
/v1/orgs/{org}/projects/{project}/alerts/{name}
EditAlert edits a virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be updated in the runtime
delete
/v1/orgs/{org}/projects/{project}/alerts/{name}
DeleteAlert deletes the virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be deleted in the runtime
post
/v1/orgs/{org}/projects/{project}/alerts/{name}/unsubscribe
UnsubscribeAlert removes the calling user from a alert's recipients list
get
/v1/orgs/{org}/projects/{project}/alerts/{name}/yaml
GenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
get
/v1/orgs/{org}/projects/{project}/clone-credentials
GetCloneCredentials returns credentials and other details for a project's Git repository or archive path if git repo is not configured.
post
/v1/orgs/{org}/projects/{project}/connect-to-github
Connects a rill managed project to github. Replaces the contents of the remote repo with the contents of the project.
post
/v1/orgs/{org}/projects/{project}/credentials
GetDeploymentCredentials returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes DEPRECATED: Clients should call GetDeployment instead.
get
/v1/orgs/{org}/projects/{project}/deployments
ListDeployments lists deployments for a project.
post
/v1/orgs/{org}/projects/{project}/deployments
CreateDeployment creates a new deployment for a project.
get
/v1/orgs/{org}/projects/{project}/embed-users/{id}
GetEmbedUser returns an embed user, which is created when GetIFrame is called with an external user ID. It is used to show which external user owns a report created from an embed.
post
/v1/orgs/{org}/projects/{project}/github/pr
CreateGithubPullRequest creates a Github PR from the specified branch in the project's connected Github repository to the primary branch.
get
/v1/orgs/{org}/projects/{project}/github/pr/{branch}
GetGithubPullRequest returns the status of the PR for the specified branch, if it exists.
post
/v1/orgs/{org}/projects/{project}/hibernate
HibernateProject hibernates a project by tearing down its deployments.
post
/v1/orgs/{org}/projects/{project}/iframe
GetIFrame returns the iframe URL for the given project
get
/v1/orgs/{org}/projects/{project}/invites
ListProjectInvites lists all the project invites
get
/v1/orgs/{org}/projects/{project}/members
ListProjectMemberUsers lists all the project members
post
/v1/orgs/{org}/projects/{project}/members
AddProjectMemberUser adds a member to the project
get
/v1/orgs/{org}/projects/{project}/members/{email}
GetProjectMemberUser gets the member details
put
/v1/orgs/{org}/projects/{project}/members/{email}
SetProjectMemberUserRole sets the role for the member
delete
/v1/orgs/{org}/projects/{project}/members/{email}
RemoveProjectMemberUser removes member from the project
get
/v1/orgs/{org}/projects/{project}/members/{email}/usergroups
ListUsergroupsForProjectAndUser returns the user groups for a user within a project
get
/v1/orgs/{org}/projects/{project}/personal-files
ListPersonalFiles lists the calling user's personal files.
post
/v1/orgs/{org}/projects/{project}/personal-files
CreatePersonalFile creates a personal (owner-only) resource as a virtual file in the project.
get
/v1/orgs/{org}/projects/{project}/personal-files/{name}
GetPersonalFile returns the YAML body and metadata for a personal virtual file the caller owns.
post
/v1/orgs/{org}/projects/{project}/personal-files/{name}
EditPersonalFile updates the YAML body of a personal virtual file the caller owns.
delete
/v1/orgs/{org}/projects/{project}/personal-files/{name}
DeletePersonalFile deletes a personal virtual file the caller owns.
post
/v1/orgs/{org}/projects/{project}/redeploy
RedeployProject creates a new production deployment for a project. If the project currently has another production deployment, the old deployment will be deprovisioned. This RPC can be used to redeploy a project that has been hibernated.
post
/v1/orgs/{org}/projects/{project}/reports
CreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog
post
/v1/orgs/{org}/projects/{project}/reports/-/yaml
GenerateReportYAML generates YAML for a scheduled report to be copied into a project's Git repository
put
/v1/orgs/{org}/projects/{project}/reports/{name}
EditReport edits a virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be updated in the runtime
delete
/v1/orgs/{org}/projects/{project}/reports/{name}
DeleteReport deletes the virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be deleted in the runtime
post
/v1/orgs/{org}/projects/{project}/reports/{name}/trigger
TriggerReport triggers an ad-hoc report run
post
/v1/orgs/{org}/projects/{project}/reports/{name}/unsubscribe
UnsubscribeReport removes the calling user from a reports recipients list
post
/v1/orgs/{org}/projects/{project}/request-access
get
/v1/orgs/{org}/projects/{project}/services
ListProjectMemberServices returns all the services for the project for an organization
delete
/v1/orgs/{org}/projects/{project}/services/{name}
RemoveProjectMemberService removes the service from the project
put
/v1/orgs/{org}/projects/{project}/services/{name}/role
SetProjectMemberServiceRole updates the project role for the service
get
/v1/orgs/{org}/projects/{project}/tokens/magic
ListMagicAuthTokens lists all the magic auth tokens for a specific project.
post
/v1/orgs/{org}/projects/{project}/tokens/magic
IssueMagicAuthToken creates a "magic" auth token that provides limited access to a specific filtered dashboard in a specific project.
get
/v1/orgs/{org}/projects/{project}/usergroups
ListProjectMemberUsergroups lists the user groups assigned to a project
put
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
SetProjectMemberUsergroupRole sets the role for the user group
post
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
AddProjectMemberUsergroup adds a user group to the project with a role
delete
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
RemoveProjectMemberUsergroup revokes the project-level role for the user group
get
/v1/orgs/{org}/projects/{project}/users/search
SearchProjectUsers returns users who has access to to a project (including org members that have access through a usergroup)
get
/v1/orgs/{org}/projects/{project}/variables
GetProjectVariables returns project variables.
put
/v1/orgs/{org}/projects/{project}/variables
UpdateProjectVariables updates variables for a project.
get
/v1/orgs/{org}/projects/{project}/whitelisted
ListWhitelistedDomains lists all the whitelisted domains of the project
post
/v1/orgs/{org}/projects/{project}/whitelisted
CreateProjectWhitelistedDomain adds a domain to the project's whitelisted
delete
/v1/orgs/{org}/projects/{project}/whitelisted/{domain}
RemoveProjectWhitelistedDomain removes a domain from the project's whitelisted
get
/v1/orgs/{org}/services
ListService returns all the services per organization
post
/v1/orgs/{org}/services
CreateService creates a new service per organization
post
/v1/superuser/organizations/{org}/billing/message
SudoUpdateOrganizationBillingMessage sets (overriding any existing) a custom message banner for the organization
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to SudoUpdateOrganizationBillingMessage sets (overriding any existing) a custom message banner for the organization
post
/v1/superuser/organizations/{org}/billing/message
Jun 8, 2026
v1
adc665ef8c17
Revision changes
info
endpoint added