/
RI
rilldata
/
Rill Admin API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 57m ago · Updated 2w ago
Details
Filter operations
post
Complete sends the messages of a chat to the AI and asks it to generate a new message.
post
GetBillingProjectCredentials returns credentials for the configured cloud metrics project filtered by request organization
get
ListPublicBillingPlans lists all public billing plans
delete
DeleteDeployment deletes a deployment.
get
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
GetDeployment returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes
post
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
TriggerReconcile triggers reconcile for the project's prod deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post
TriggerRefreshSources refresh the source for production deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post
StartDeployment starts a deployment.
post
StopDeployment stops a deployment.
get
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
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
RevokeMagicAuthToken revokes a magic auth token.
get
GetCurrentMagicAuthToken returns information about the current magic auth token.
get
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
ListOrganizations lists all the organizations currently managed by the admin
post
CreateOrganization creates a new organization
get
GetOrganization returns information about a specific organization
delete
DeleteOrganization deletes an organization
patch
UpdateOrganization updates an organization
get
GetBillingCreditBalance returns the organization's remaining trial credit balance
get
ListOrganizationBillingIssues lists all the billing issues for the organization
get
GetPaymentsPortalURL returns the URL for the billing session to collect payment method
get
GetBillingSubscription lists the subscription for the organization
delete
CancelBillingSubscription cancels the billing subscription for the organization
patch
UpdateBillingSubscription updates the billing plan for the organization
post
RenewBillingSubscription renews the billing plan for the organization once cancelled
put
CreateManagedGitRepo creates a new rill managed git repo for the organization.
post
CreateAsset returns a one time signed URL using which any asset can be uploaded.
get
ListOrganizationInvites lists all the org invites
get
ListOrganizationMemberUsers lists all the org members
post
AddOrganizationMemberUser adds a user to the organization
get
GetOrganizationMemberUser gets the member details
put
SetOrganizationMemberUserRole sets the role for the member
delete
RemoveOrganizationMemberUser removes member from the organization
put
UpdateOrganizationMemberUserAttributes updates the attributes for a member
delete
LeaveOrganization removes the current user from the organization
get
ListProjectsForOrganization lists all the projects currently available for a given organization.
post
CreateProject creates a new project
get
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
GetProject returns information about a specific project
delete
DeleteProject deletes a project
patch
UpdateProject updates a project
post
CreateAlert adds a virtual file for an alert, triggers a reconcile, and waits for the alert to be added to the runtime catalog
post
GenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
put
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
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
UnsubscribeAlert removes the calling user from a alert's recipients list
get
GenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
get
GetCloneCredentials returns credentials and other details for a project's Git repository or archive path if git repo is not configured.
post
Connects a rill managed project to github. Replaces the contents of the remote repo with the contents of the project.
post
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
ListDeployments lists deployments for a project.
post
CreateDeployment creates a new deployment for a project.
post
CreateGithubPullRequest creates a Github PR from the specified branch in the project's connected Github repository to the primary branch.
get
GetGithubPullRequest returns the status of the PR for the specified branch, if it exists.
post
HibernateProject hibernates a project by tearing down its deployments.
post
GetIFrame returns the iframe URL for the given project
get
ListProjectInvites lists all the project invites
get
ListProjectMemberUsers lists all the project members
post
AddProjectMemberUser adds a member to the project
get
GetProjectMemberUser gets the member details
put
SetProjectMemberUserRole sets the role for the member
delete
RemoveProjectMemberUser removes member from the project
get
ListUsergroupsForProjectAndUser returns the user groups for a user within a project
get
ListPersonalFiles lists the calling user's personal files.
post
CreatePersonalFile creates a personal (owner-only) resource as a virtual file in the project.
get
GetPersonalFile returns the YAML body and metadata for a personal virtual file the caller owns.
post
EditPersonalFile updates the YAML body of a personal virtual file the caller owns.
delete
DeletePersonalFile deletes a personal virtual file the caller owns.
post
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
CreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog
post
GenerateReportYAML generates YAML for a scheduled report to be copied into a project's Git repository
put
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
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
TriggerReport triggers an ad-hoc report run
post
UnsubscribeReport removes the calling user from a reports recipients list
post
/v1/orgs/{org}/projects/{project}/request-access
get
ListProjectMemberServices returns all the services for the project for an organization
delete
RemoveProjectMemberService removes the service from the project
put
SetProjectMemberServiceRole updates the project role for the service
get
ListMagicAuthTokens lists all the magic auth tokens for a specific project.
post
IssueMagicAuthToken creates a "magic" auth token that provides limited access to a specific filtered dashboard in a specific project.
get
ListProjectMemberUsergroups lists the user groups assigned to a project
put
SetProjectMemberUsergroupRole sets the role for the user group
post
AddProjectMemberUsergroup adds a user group to the project with a role
delete
RemoveProjectMemberUsergroup revokes the project-level role for the user group
get
SearchProjectUsers returns users who has access to to a project (including org members that have access through a usergroup)
get
GetProjectVariables returns project variables.
put
UpdateProjectVariables updates variables for a project.
get
ListWhitelistedDomains lists all the whitelisted domains of the project
post
CreateProjectWhitelistedDomain adds a domain to the project's whitelisted
delete
RemoveProjectWhitelistedDomain removes a domain from the project's whitelisted
get
ListService returns all the services per organization
post
CreateService creates a new service per organization
get
GetService returns information about a specific service
delete
DeleteService deletes a service per organization
patch
UpdateService updates a service per organization
put
SetOrganizationMemberServiceRole sets or updates the role of the service in the organization
StartDeployment starts a deployment.
post
/v1/deployments/{deploymentId}/start
Path parameters
deploymentId
string
required
Request body
object
required
Response
A successful response.
V1StartDeploymentResponse
required
deployment
V1Deployment
Changes