Skip to main content
API docs by Redocly

Rill Admin API (1.0.0)

Download OpenAPI specification:Download

Rill Admin API enables programmatic management of Rill Cloud resources, including organizations, projects, and user access. It provides endpoints for creating, updating, and deleting these resources, as well as managing authentication and permissions.

Rill API Documentation

ListOrganizations lists all the organizations currently managed by the admin

query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "organizations": [
    ]
}

CreateOrganization creates a new organization

Request Body schema: application/json
required
description
string
displayName
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "displayName": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "organization": {
    }
}

DeleteOrganization deletes an organization

path Parameters
org
required
string

Responses

Response samples

Content type
application/json
{ }

GetOrganization returns information about a specific organization

path Parameters
org
required
string
query Parameters
superuserForceAccess
boolean

Responses

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "permissions": {
    }
}

UpdateOrganization updates an organization

path Parameters
org
required
string
Request Body schema: application/json
required
billingEmail
string
defaultProjectRole
string
description
string
displayName
string
faviconAssetId
string
logoAssetId
string
logoDarkAssetId
string
newName
string
thumbnailAssetId
string

Responses

Request samples

Content type
application/json
{
  • "billingEmail": "string",
  • "defaultProjectRole": "string",
  • "description": "string",
  • "displayName": "string",
  • "faviconAssetId": "string",
  • "logoAssetId": "string",
  • "logoDarkAssetId": "string",
  • "newName": "string",
  • "thumbnailAssetId": "string"
}

Response samples

Content type
application/json
{
  • "organization": {
    }
}

ListOrganizationInvites lists all the org invites

path Parameters
org
required
string
query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "invites": [
    ],
  • "nextPageToken": "string",
  • "totalCount": 0
}

ListOrganizationMemberUsers lists all the org members

path Parameters
org
required
string
query Parameters
role
string

Optionally filter by role

includeCounts
boolean

Optionally include counts

pageSize
integer <int64>
pageToken
string
superuserForceAccess
boolean
searchPattern
string

Optional search pattern to filter users by email or display name

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "nextPageToken": "string",
  • "totalCount": 0
}

AddOrganizationMemberUser adds a user to the organization

path Parameters
org
required
string
Request Body schema: application/json
required
attributes
object

Custom attributes to set on the new membership. If the user has not signed up yet, they are stored on the invite and applied when the invite is accepted.

email
string
role
string
superuserForceAccess
boolean
usergroups
Array of strings

Names of user groups in the org to add the user to. If the user has not signed up yet, they are stored on the invite and applied when the invite is accepted. Groups are additive: on a re-invite they are merged with the groups already on the invite.

Responses

Request samples

Content type
application/json
{
  • "attributes": { },
  • "email": "string",
  • "role": "string",
  • "superuserForceAccess": true,
  • "usergroups": [
    ]
}

Response samples

Content type
application/json
{
  • "pendingSignup": true
}

RemoveOrganizationMemberUser removes member from the organization

path Parameters
org
required
string
email
required
string

Responses

Response samples

Content type
application/json
{ }

ListProjectsForOrganization lists all the projects currently available for a given organization.

path Parameters
org
required
string
query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "projects": [
    ]
}

CreateProject creates a new project

path Parameters
org
required
string
Request Body schema: application/json
required
archiveAssetId
string

archive_asset_id is set for projects whose project files are not stored in github but are managed by rill.

description
string
devSlots
string <int64>
directoryName
string

directory_name should be the most recently observed local directory name for the project. See ListProjectsForFingerprint for more context.

gitRemote
string

git_remote is set for projects whose project files are stored in Git. It currently only supports Github remotes. It should be a HTTPS remote ending in .git for github.com. Either git_remote or archive_asset_id should be set.

primaryBranch
string
prodSlots
string <int64>
prodVersion
string
project
string
provisioner
string

Provisioner to use for the project's deployments. Superuser-only; empty means the org's default provisioner (or the global default) is used.

public
boolean
skipDeploy
boolean
subpath
string

Responses

Request samples

Content type
application/json
{
  • "archiveAssetId": "string",
  • "description": "string",
  • "devSlots": "string",
  • "directoryName": "string",
  • "gitRemote": "string",
  • "primaryBranch": "string",
  • "prodSlots": "string",
  • "prodVersion": "string",
  • "project": "string",
  • "provisioner": "string",
  • "public": true,
  • "skipDeploy": true,
  • "subpath": "string"
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

DeleteProject deletes a project

path Parameters
org
required
string
project
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

GetProject returns information about a specific project

path Parameters
org
required
string
project
required
string
query Parameters
branch
string

Optional branch to get deployment for. If not set, then project's primary_branch is used.

accessTokenTtlSeconds
integer <int64>
superuserForceAccess
boolean
issueSuperuserToken
boolean

Responses

Response samples

Content type
application/json
{
  • "deployment": {
    },
  • "jwt": "string",
  • "project": {
    },
  • "projectPermissions": {
    }
}

UpdateProject updates a project

path Parameters
org
required
string
project
required
string
Request Body schema: application/json
required
archiveAssetId
string
description
string
devSlots
string <int64>
devTtlSeconds
string <int64>
directoryName
string
gitRemote
string
newName
string
overrideDiskGb
string <int64>
primaryBranch
string
prodSlots
string <int64>
prodTtlSeconds
string <int64>
prodVersion
string
provisioner
string

Provisioner to use for the project's deployments. Superuser-only; empty unsets it so the org's default provisioner (or the global default) is used. It only affects deployments provisioned after the change; existing deployments stay on their current provisioner.

public
boolean
subpath
string
superuserForceAccess
boolean

Responses

Request samples

Content type
application/json
{
  • "archiveAssetId": "string",
  • "description": "string",
  • "devSlots": "string",
  • "devTtlSeconds": "string",
  • "directoryName": "string",
  • "gitRemote": "string",
  • "newName": "string",
  • "overrideDiskGb": "string",
  • "primaryBranch": "string",
  • "prodSlots": "string",
  • "prodTtlSeconds": "string",
  • "prodVersion": "string",
  • "provisioner": "string",
  • "public": true,
  • "subpath": "string",
  • "superuserForceAccess": true
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

ListProjectInvites lists all the project invites

path Parameters
org
required
string
project
required
string
query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "invites": [
    ],
  • "nextPageToken": "string"
}

ListProjectMemberUsers lists all the project members

path Parameters
org
required
string
project
required
string
query Parameters
role
string

Optionally filter by role

pageSize
integer <int64>
pageToken
string
superuserForceAccess
boolean

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "nextPageToken": "string"
}

AddProjectMemberUser adds a member to the project

path Parameters
org
required
string
project
required
string
Request Body schema: application/json
required
attributes
object

Custom attributes to set on the user's org membership (attributes are org-scoped). If the user has not signed up yet, they are stored on the org invite and applied when the invite is accepted. Setting attributes requires permission to manage org members.

email
string
Array of objects (v1ResourceName)
restrictResources
boolean
role
string
usergroups
Array of strings

Names of user groups in the org to add the user to (user groups are org-scoped). If the user has not signed up yet, they are stored on the org invite and applied when the invite is accepted. Setting user groups requires permission to manage org members.

Responses

Request samples

Content type
application/json
{
  • "attributes": { },
  • "email": "string",
  • "resources": [
    ],
  • "restrictResources": true,
  • "role": "string",
  • "usergroups": [
    ]
}

Response samples

Content type
application/json
{
  • "pendingSignup": true
}

RemoveProjectMemberUser removes member from the project

path Parameters
org
required
string
project
required
string
email
required
string

Responses

Response samples

Content type
application/json
{ }

GetProjectMemberUser gets the member details

path Parameters
org
required
string
project
required
string
email
required
string

Responses

Response samples

Content type
application/json
{
  • "member": {
    }
}

SetProjectMemberUserRole sets the role for the member

path Parameters
org
required
string
project
required
string
email
required
string
Request Body schema: application/json
required
Array of objects (v1ResourceName)
restrictResources
boolean
role
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ],
  • "restrictResources": true,
  • "role": "string"
}

Response samples

Content type
application/json
{ }

ListProjectMemberUsergroups lists the user groups assigned to a project

path Parameters
org
required
string
project
required
string
query Parameters
role
string

Optionally filter by role

includeCounts
boolean

Optionally include counts

pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "nextPageToken": "string"
}

RemoveProjectMemberUsergroup revokes the project-level role for the user group

path Parameters
org
required
string
project
required
string
usergroup
required
string

Responses

Response samples

Content type
application/json
{ }

AddProjectMemberUsergroup adds a user group to the project with a role

path Parameters
org
required
string
project
required
string
usergroup
required
string
Request Body schema: application/json
required
Array of objects (v1ResourceName)
restrictResources
boolean
role
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ],
  • "restrictResources": true,
  • "role": "string"
}

Response samples

Content type
application/json
{ }

SetProjectMemberUsergroupRole sets the role for the user group

path Parameters
org
required
string
project
required
string
usergroup
required
string
Request Body schema: application/json
required
Array of objects (v1ResourceName)
restrictResources
boolean
role
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ],
  • "restrictResources": true,
  • "role": "string"
}

Response samples

Content type
application/json
{ }

GetProjectVariables returns project variables.

path Parameters
org
required
string

Org the project belongs to.

project
required
string

Project to get variables for.

query Parameters
environment
string

Environment to get the variables for. If empty, only variables shared across all environments are returned.

forAllEnvironments
boolean

If true, return variable values for all environments. Can't be used together with the "environment" option.

Responses

Response samples

Content type
application/json
{
  • "variables": [
    ],
  • "variablesMap": {
    }
}

ListOrganizationMemberUsergroups lists the organization's user groups

path Parameters
org
required
string
query Parameters
role
string

Optionally filter by role

includeCounts
boolean

Optionally include counts

pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "nextPageToken": "string"
}

CreateUsergroup creates a user group in the organization

path Parameters
org
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "usergroup": {
    }
}

DeleteUsergroup deletes the user group from the organization

path Parameters
org
required
string
usergroup
required
string

Responses

Response samples

Content type
application/json
{ }

GetUsergroup returns the user group details

path Parameters
org
required
string
usergroup
required
string
query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "usergroup": {
    }
}

UpdateUsergroup updates a user group's name and/or description

path Parameters
org
required
string
usergroup
required
string
Request Body schema: application/json
required
description
string
newName
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "newName": "string"
}

Response samples

Content type
application/json
{
  • "usergroup": {
    }
}

ListUsergroupMemberUsers lists all the user group members

path Parameters
org
required
string
usergroup
required
string
query Parameters
pageSize
integer <int64>
pageToken
string

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "nextPageToken": "string"
}

RemoveUsergroupMemberUser removes member from the user group

path Parameters
org
required
string
usergroup
required
string
email
required
string

Responses

Response samples

Content type
application/json
{ }

AddUsergroupMemberUser adds a member to the user group

path Parameters
org
required
string
usergroup
required
string
email
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }