Skip to main content
API docs by Redocly

Rill Admin API (v0.75.5)

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 deletes an organizations

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

Responses

Request samples

Content type
application/json
{
  • "billingEmail": "string",
  • "defaultProjectRole": "string",
  • "description": "string",
  • "displayName": "string",
  • "faviconAssetId": "string",
  • "logoAssetId": "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
email
string
role
string
superuserForceAccess
boolean

Responses

Request samples

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

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 given organizations.

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
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.

prodBranch
string
prodSlots
string <int64>
prodVersion
string
project
string
provisioner
string
public
boolean
skipDeploy
boolean
subpath
string

Responses

Request samples

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

Response samples

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

DeleteProject deletes an 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
accessTokenTtlSeconds
integer <int64>
superuserForceAccess
boolean
issueSuperuserToken
boolean

Responses

Response samples

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

UpdateProject updates a project

path Parameters
org
required
string
project
required
string
Request Body schema: application/json
required
archiveAssetId
string
description
string
directoryName
string
gitRemote
string
newName
string
prodBranch
string
prodSlots
string <int64>
prodTtlSeconds
string <int64>
prodVersion
string
provisioner
string
public
boolean
subpath
string
superuserForceAccess
boolean

Responses

Request samples

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

Response samples

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

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": {
    }
}