Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rill Data Orgs API

The Orgs API from Rill Data — 17 operation(s) for orgs.

Rill Data Orgs API is published by Rill Data on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 33 operations across 17 paths, and defines 52 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against the base URL https://api.rilldata.com.

33 operations 17 paths 52 schemas 7 DELETE14 GET3 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.rilldata.com
Resource Areas
1

Paths & Operations 33

Across 17 paths, the API surfaces 33 operations — 7 DELETE, 14 GET, 3 PATCH, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs 33
GET
/v1/orgs
ListOrganizations lists all the organizations currently managed by the admin
AdminService_ListOrganizations 2 params → 200default
POST
/v1/orgs
CreateOrganization creates a new organization
AdminService_CreateOrganization body → 200default
DELETE
/v1/orgs/{org}
DeleteOrganization deletes an organization
AdminService_DeleteOrganization 1 param → 200default
GET
/v1/orgs/{org}
GetOrganization returns information about a specific organization
AdminService_GetOrganization 2 params → 200default
PATCH
/v1/orgs/{org}
UpdateOrganization updates an organization
AdminService_UpdateOrganization 1 param body → 200default
GET
/v1/orgs/{org}/invites
ListOrganizationInvites lists all the org invites
AdminService_ListOrganizationInvites 3 params → 200default
GET
/v1/orgs/{org}/members
ListOrganizationMemberUsers lists all the org members
AdminService_ListOrganizationMemberUsers 7 params → 200default
POST
/v1/orgs/{org}/members
AddOrganizationMemberUser adds a user to the organization
AdminService_AddOrganizationMemberUser 1 param body → 200default
DELETE
/v1/orgs/{org}/members/{email}
RemoveOrganizationMemberUser removes member from the organization
AdminService_RemoveOrganizationMemberUser 2 params → 200default
GET
/v1/orgs/{org}/projects
ListProjectsForOrganization lists all the projects currently available for a given organization.
AdminService_ListProjectsForOrganization 3 params → 200default
POST
/v1/orgs/{org}/projects
CreateProject creates a new project
AdminService_CreateProject 1 param body → 200default
DELETE
/v1/orgs/{org}/projects/{project}
DeleteProject deletes a project
AdminService_DeleteProject 2 params → 200default
GET
/v1/orgs/{org}/projects/{project}
GetProject returns information about a specific project
AdminService_GetProject 6 params → 200default
PATCH
/v1/orgs/{org}/projects/{project}
UpdateProject updates a project
AdminService_UpdateProject 2 params body → 200default
GET
/v1/orgs/{org}/projects/{project}/invites
ListProjectInvites lists all the project invites
AdminService_ListProjectInvites 4 params → 200default
GET
/v1/orgs/{org}/projects/{project}/members
ListProjectMemberUsers lists all the project members
AdminService_ListProjectMemberUsers 6 params → 200default
POST
/v1/orgs/{org}/projects/{project}/members
AddProjectMemberUser adds a member to the project
AdminService_AddProjectMemberUser 2 params body → 200default
DELETE
/v1/orgs/{org}/projects/{project}/members/{email}
RemoveProjectMemberUser removes member from the project
AdminService_RemoveProjectMemberUser 3 params → 200default
GET
/v1/orgs/{org}/projects/{project}/members/{email}
GetProjectMemberUser gets the member details
AdminService_GetProjectMemberUser 3 params → 200default
PUT
/v1/orgs/{org}/projects/{project}/members/{email}
SetProjectMemberUserRole sets the role for the member
AdminService_SetProjectMemberUserRole 3 params body → 200default
GET
/v1/orgs/{org}/projects/{project}/usergroups
ListProjectMemberUsergroups lists the user groups assigned to a project
AdminService_ListProjectMemberUsergroups 6 params → 200default
DELETE
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
RemoveProjectMemberUsergroup revokes the project-level role for the user group
AdminService_RemoveProjectMemberUsergroup 3 params → 200default
POST
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
AddProjectMemberUsergroup adds a user group to the project with a role
AdminService_AddProjectMemberUsergroup 3 params body → 200default
PUT
/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/roles
SetProjectMemberUsergroupRole sets the role for the user group
AdminService_SetProjectMemberUsergroupRole 3 params body → 200default
GET
/v1/orgs/{org}/projects/{project}/variables
GetProjectVariables returns project variables.
AdminService_GetProjectVariables 4 params → 200default
GET
/v1/orgs/{org}/usergroups
ListOrganizationMemberUsergroups lists the organization's user groups
AdminService_ListOrganizationMemberUsergroups 5 params → 200default
POST
/v1/orgs/{org}/usergroups
CreateUsergroup creates a user group in the organization
AdminService_CreateUsergroup 1 param body → 200default
DELETE
/v1/orgs/{org}/usergroups/{usergroup}
DeleteUsergroup deletes the user group from the organization
AdminService_DeleteUsergroup 2 params → 200default
GET
/v1/orgs/{org}/usergroups/{usergroup}
GetUsergroup returns the user group details
AdminService_GetUsergroup 4 params → 200default
PATCH
/v1/orgs/{org}/usergroups/{usergroup}
UpdateUsergroup updates a user group's name and/or description
AdminService_UpdateUsergroup 2 params body → 200default
GET
/v1/orgs/{org}/usergroups/{usergroup}/members
ListUsergroupMemberUsers lists all the user group members
AdminService_ListUsergroupMemberUsers 4 params → 200default
DELETE
/v1/orgs/{org}/usergroups/{usergroup}/members/{email}
RemoveUsergroupMemberUser removes member from the user group
AdminService_RemoveUsergroupMemberUser 3 params → 200default
PUT
/v1/orgs/{org}/usergroups/{usergroup}/members/{email}
AddUsergroupMemberUser adds a member to the user group
AdminService_AddUsergroupMemberUser 3 params body → 200default

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are v1Project (25 properties), v1ProjectPermissions (22 properties), v1Organization (18 properties), v1Deployment (13 properties). Each schema is shown below with its type and property counts.

v1DeploymentStatus
string
v1AddOrganizationMemberUserResponse
object
1 property
v1ListProjectMemberUsergroupsResponse
object
2 properties
v1ListProjectMemberUsersResponse
object
2 properties
v1ListOrganizationInvitesResponse
object
3 properties
v1GetProjectResponse
object
4 properties
v1CreateUsergroupResponse
object
1 property
v1RemoveUsergroupMemberUserResponse
object
v1ListOrganizationMemberUsersResponse
object
3 properties
v1UpdateOrganizationResponse
object
1 property
v1SetProjectMemberUsergroupRoleResponse
object
v1UsergroupMemberUser
object
6 properties
v1AddProjectMemberUsergroupResponse
object
v1ListUsergroupMemberUsersResponse
object
2 properties
v1GetProjectVariablesResponse
object
2 properties
v1OrganizationMemberUser
object
10 properties
v1DeleteOrganizationResponse
object
v1OrganizationInvite
object
3 properties
v1CreateOrganizationRequest
object
3 properties
v1ProjectMemberUser
object
10 properties
v1CreateProjectResponse
object
1 property
v1SetProjectMemberUserRoleResponse
object
v1ResourceName
object
2 properties
v1ProjectInvite
object
6 properties
v1Organization
object
18 properties
v1AddUsergroupMemberUserResponse
object
rpcStatus
object
3 properties
v1GetUsergroupResponse
object
2 properties
v1ProjectVariable
object
7 properties
v1UpdateProjectResponse
object
1 property
v1ListProjectsForOrganizationResponse
object
2 properties
v1RemoveProjectMemberUserResponse
object
v1ListOrganizationMemberUsergroupsResponse
object
2 properties
v1RemoveOrganizationMemberUserResponse
object
v1CreateOrganizationResponse
object
1 property
v1GetOrganizationResponse
object
2 properties
v1DeleteProjectResponse
object
1 property
v1DeleteUsergroupResponse
object
v1OrganizationQuotas
object
7 properties
v1Project
object
25 properties
v1ListOrganizationsResponse
object
2 properties
v1ProjectPermissions
object
22 properties
v1ListProjectInvitesResponse
object
2 properties
v1AddProjectMemberUserResponse
object
1 property
v1RemoveProjectMemberUsergroupResponse
object
v1GetProjectMemberUserResponse
object
1 property
v1Usergroup
object
6 properties
v1UpdateUsergroupResponse
object
1 property
v1OrganizationPermissions
object
10 properties
v1MemberUsergroup
object
9 properties
protobufAny
object
1 property
v1Deployment
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rill-data-orgs-api-openapi.yml Raw ↑