/

/Rill Admin API

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 36m ago · Updated 2w ago

Filter operations

postComplete sends the messages of a chat to the AI and asks it to generate a new message.
postGetBillingProjectCredentials returns credentials for the configured cloud metrics project filtered by request organization
getListPublicBillingPlans lists all public billing plans
deleteDeleteDeployment deletes a deployment.
getGetDeploymentConfig 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.
postGetDeployment returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes
postProvision provisions a new resource for a deployment. If an existing resource matches the request, it will be returned without provisioning a new resource.
postTriggerReconcile triggers reconcile for the project's prod deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
postTriggerRefreshSources refresh the source for production deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
postStartDeployment starts a deployment.
postStopDeployment stops a deployment.
getGetGithubRepoRequest 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.
getGetGithubUserStatus 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
deleteRevokeMagicAuthToken revokes a magic auth token.
getGetCurrentMagicAuthToken returns information about the current magic auth token.
getGetOrganizationNameForDomain 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.
getListOrganizations lists all the organizations currently managed by the admin
postCreateOrganization creates a new organization
getGetOrganization returns information about a specific organization
deleteDeleteOrganization deletes an organization
patchUpdateOrganization updates an organization
getGetBillingCreditBalance returns the organization's remaining trial credit balance
getListOrganizationBillingIssues lists all the billing issues for the organization
getGetPaymentsPortalURL returns the URL for the billing session to collect payment method
getGetBillingSubscription lists the subscription for the organization
deleteCancelBillingSubscription cancels the billing subscription for the organization
patchUpdateBillingSubscription updates the billing plan for the organization
postRenewBillingSubscription renews the billing plan for the organization once cancelled
putCreateManagedGitRepo creates a new rill managed git repo for the organization.
postCreateAsset returns a one time signed URL using which any asset can be uploaded.
getListOrganizationInvites lists all the org invites
getListOrganizationMemberUsers lists all the org members
postAddOrganizationMemberUser adds a user to the organization
getGetOrganizationMemberUser gets the member details
putSetOrganizationMemberUserRole sets the role for the member
deleteRemoveOrganizationMemberUser removes member from the organization
putUpdateOrganizationMemberUserAttributes updates the attributes for a member
deleteLeaveOrganization removes the current user from the organization
getListProjectsForOrganization lists all the projects currently available for a given organization.
postCreateProject creates a new project
getListProjectsForOrganizationAndUser 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.
getGetProject returns information about a specific project
deleteDeleteProject deletes a project
patchUpdateProject updates a project
postCreateAlert adds a virtual file for an alert, triggers a reconcile, and waits for the alert to be added to the runtime catalog
postGenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
putEditAlert edits a virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be updated in the runtime
deleteDeleteAlert deletes the virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be deleted in the runtime
postUnsubscribeAlert removes the calling user from a alert's recipients list
getGenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
getGetCloneCredentials returns credentials and other details for a project's Git repository or archive path if git repo is not configured.
postConnects a rill managed project to github. Replaces the contents of the remote repo with the contents of the project.
postGetDeploymentCredentials 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.
getListDeployments lists deployments for a project.
postCreateDeployment creates a new deployment for a project.
postCreateGithubPullRequest creates a Github PR from the specified branch in the project's connected Github repository to the primary branch.
getGetGithubPullRequest returns the status of the PR for the specified branch, if it exists.
postHibernateProject hibernates a project by tearing down its deployments.
postGetIFrame returns the iframe URL for the given project
getListProjectInvites lists all the project invites
getListProjectMemberUsers lists all the project members
postAddProjectMemberUser adds a member to the project
getGetProjectMemberUser gets the member details
putSetProjectMemberUserRole sets the role for the member
deleteRemoveProjectMemberUser removes member from the project
getListUsergroupsForProjectAndUser returns the user groups for a user within a project
getListPersonalFiles lists the calling user's personal files.
postCreatePersonalFile creates a personal (owner-only) resource as a virtual file in the project.
getGetPersonalFile returns the YAML body and metadata for a personal virtual file the caller owns.
postEditPersonalFile updates the YAML body of a personal virtual file the caller owns.
deleteDeletePersonalFile deletes a personal virtual file the caller owns.
postRedeployProject 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.
postCreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog
postGenerateReportYAML generates YAML for a scheduled report to be copied into a project's Git repository
putEditReport edits a virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be updated in the runtime
deleteDeleteReport deletes the virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be deleted in the runtime
postTriggerReport triggers an ad-hoc report run
postUnsubscribeReport removes the calling user from a reports recipients list
post/v1/orgs/{org}/projects/{project}/request-access
getListProjectMemberServices returns all the services for the project for an organization
deleteRemoveProjectMemberService removes the service from the project
putSetProjectMemberServiceRole updates the project role for the service
getListMagicAuthTokens lists all the magic auth tokens for a specific project.
postIssueMagicAuthToken creates a "magic" auth token that provides limited access to a specific filtered dashboard in a specific project.
getListProjectMemberUsergroups lists the user groups assigned to a project
putSetProjectMemberUsergroupRole sets the role for the user group
postAddProjectMemberUsergroup adds a user group to the project with a role
deleteRemoveProjectMemberUsergroup revokes the project-level role for the user group
getSearchProjectUsers returns users who has access to to a project (including org members that have access through a usergroup)
getGetProjectVariables returns project variables.
putUpdateProjectVariables updates variables for a project.
getListWhitelistedDomains lists all the whitelisted domains of the project
postCreateProjectWhitelistedDomain adds a domain to the project's whitelisted
deleteRemoveProjectWhitelistedDomain removes a domain from the project's whitelisted
getListService returns all the services per organization
postCreateService creates a new service per organization
getGetService returns information about a specific service
deleteDeleteService deletes a service per organization
patchUpdateService updates a service per organization
getGetUsersByEmail returns users by email

GetUsersByEmail returns users by email

get/v1/users/search

Query parameters

emailPatternstring

pageSizeinteger

pageTokenstring

Response

A successful response.

nextPageTokenstring

Changes