API reference

ProjectService

api.plany.cloud:443Global6 methods

Create and manage projects, the containers everything you run lives in. Every game server, sandbox, network, secret and repository belongs to a project, and a project belongs to an account, which pays for it. Use projects to separate environments or games, and grant people access to one project without giving them the rest.

CreateProject

plany.project.v1.ProjectService/CreateProject

Creates a project. Fails with RESOURCE_EXHAUSTED if the account is at its projects-per-account quota, and with FAILED_PRECONDITION if the account has no credit.

Parameters

projectProjectRequired
Show child attributesHide child attributes
- display_namestringRequired
- accountstringRequired
  Owning account, accounts/{account}. Changing it is a transfer, done through a dedicated flow rather than UpdateProject.
- namestringIdentifier
  projects/{project}.
- project_idstringImmutable
  Short id unique across Plany, e.g. "survival-eu". Appears in resource names and API URLs, so it is immutable once set.
- labelsmap<string, string>
  Labels are copied onto every usage record the project generates, which is how a studio splits one bill across games, environments or customers.
- default_locationstring
  Default location for resources created without an explicit one.
project_idstring
Desired short id. Empty derives one from display_name, appending a suffix if that is taken.
request_idstring

Returns

Project.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "project": {
4      "display_name": "My server",
5      "account": "accounts/"
6    }
7  }' \
8  api.plany.cloud:443 plany.project.v1.ProjectService/CreateProject

Example response

1{
2  "name": "projects/",
3  "project_id": "my-project",
4  "display_name": "My server",
5  "account": "accounts/",
6  "state": "STATE_ACTIVE",
7  "labels": {
8    "key": ""
9  },
10  "default_location": "",
11  "create_time": "2026-10-04T12:00:00Z",
12  "update_time": "2026-10-04T12:00:00Z",
13  "purge_time": "2026-10-04T12:00:00Z",
14  "etag": "W/\"1\"",
15  "active_locations": [
16    ""
17  ]
18}

GetProject

Read

plany.project.v1.ProjectService/GetProject

Parameters

namestringRequired

Returns

Project.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "name": "projects/"
4  }' \
5  api.plany.cloud:443 plany.project.v1.ProjectService/GetProject

Example response

1{
2  "name": "projects/",
3  "project_id": "my-project",
4  "display_name": "My server",
5  "account": "accounts/",
6  "state": "STATE_ACTIVE",
7  "labels": {
8    "key": ""
9  },
10  "default_location": "",
11  "create_time": "2026-10-04T12:00:00Z",
12  "update_time": "2026-10-04T12:00:00Z",
13  "purge_time": "2026-10-04T12:00:00Z",
14  "etag": "W/\"1\"",
15  "active_locations": [
16    ""
17  ]
18}

ListProjects

Read

plany.project.v1.ProjectService/ListProjects

Parameters

accountstring
Restrict to one account. Empty lists every project the caller can see across all their accounts, which is what the console's project picker wants.
page_sizeint32
page_tokenstring
filterstring
AIP-160 filter, e.g. state = "ACTIVE" AND labels.env = "prod".
order_bystring
show_deletedbool
Include projects in PENDING_DELETION, which are hidden by default.

Returns

ListProjectsResponse.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "page_size": 50
4  }' \
5  api.plany.cloud:443 plany.project.v1.ProjectService/ListProjects

Example response

1{
2  "projects": [
3    {
4      "name": "projects/",
5      "project_id": "my-project",
6      "display_name": "My server",
7      "account": "accounts/",
8      "state": "STATE_ACTIVE",
9      "labels": {
10        "key": ""
11      },
12      "default_location": "",
13      "create_time": "2026-10-04T12:00:00Z",
14      "update_time": "2026-10-04T12:00:00Z",
15      "purge_time": "2026-10-04T12:00:00Z",
16      "etag": "W/\"1\"",
17      "active_locations": [
18        ""
19      ]
20    }
21  ],
22  "next_page_token": ""
23}

UpdateProject

plany.project.v1.ProjectService/UpdateProject

Parameters

projectProjectRequired
Show child attributesHide child attributes
- display_namestringRequired
- accountstringRequired
  Owning account, accounts/{account}. Changing it is a transfer, done through a dedicated flow rather than UpdateProject.
- namestringIdentifier
  projects/{project}.
- project_idstringImmutable
  Short id unique across Plany, e.g. "survival-eu". Appears in resource names and API URLs, so it is immutable once set.
- labelsmap<string, string>
  Labels are copied onto every usage record the project generates, which is how a studio splits one bill across games, environments or customers.
- default_locationstring
  Default location for resources created without an explicit one.
update_maskFieldMaskRequired

Returns

Project.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "project": {
4      "display_name": "My server",
5      "account": "accounts/"
6    },
7    "update_mask": "display_name"
8  }' \
9  api.plany.cloud:443 plany.project.v1.ProjectService/UpdateProject

Example response

1{
2  "name": "projects/",
3  "project_id": "my-project",
4  "display_name": "My server",
5  "account": "accounts/",
6  "state": "STATE_ACTIVE",
7  "labels": {
8    "key": ""
9  },
10  "default_location": "",
11  "create_time": "2026-10-04T12:00:00Z",
12  "update_time": "2026-10-04T12:00:00Z",
13  "purge_time": "2026-10-04T12:00:00Z",
14  "etag": "W/\"1\"",
15  "active_locations": [
16    ""
17  ]
18}

DeleteProject

Long-running

plany.project.v1.ProjectService/DeleteProject

Begins project deletion.

The project enters STATE_PENDING_DELETION and can be restored with UndeleteProject until it is purged.

Parameters

namestringRequired
etagstring
disallow_non_emptybool
Refuse the delete if the project still holds resources, instead of cascading. The safe default for scripted teardown.
validate_onlybool
request_idstring
Idempotency key. A retry returns the original operation rather than starting a second teardown, which matters because deletion fans out across every region and running it twice would race with itself.

Returns

An Operation that resolves to Empty.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "name": "projects/"
4  }' \
5  api.plany.cloud:443 plany.project.v1.ProjectService/DeleteProject

Example response

{}

UndeleteProject

plany.project.v1.ProjectService/UndeleteProject

Parameters

namestringRequired

Returns

Project.

1grpcurl -H "authorization: Bearer $PLANY_API_KEY" \
2  -d '{
3    "name": "projects/"
4  }' \
5  api.plany.cloud:443 plany.project.v1.ProjectService/UndeleteProject

Example response

1{
2  "name": "projects/",
3  "project_id": "my-project",
4  "display_name": "My server",
5  "account": "accounts/",
6  "state": "STATE_ACTIVE",
7  "labels": {
8    "key": ""
9  },
10  "default_location": "",
11  "create_time": "2026-10-04T12:00:00Z",
12  "update_time": "2026-10-04T12:00:00Z",
13  "purge_time": "2026-10-04T12:00:00Z",
14  "etag": "W/\"1\"",
15  "active_locations": [
16    ""
17  ]
18}

The DeleteProjectMetadata object

Attributes

projectstring
locationsrepeated DeleteProjectMetadata.LocationProgress
Show child attributesHide child attributes
- locationstring
- resources_totalint32
- resources_deletedint32
- errorstring
current_stepstring

DeleteProjectMetadata

1{
2  "project": "projects/",
3  "locations": [
4    {
5      "location": "",
6      "resources_total": 0,
7      "resources_deleted": 0,
8      "error": ""
9    }
10  ],
11  "current_step": ""
12}

The DeleteProjectMetadata.LocationProgress object

Per-region teardown progress, so a stuck region is visible rather than hidden behind a single aggregate percentage.

Attributes

locationstring
resources_totalint32
resources_deletedint32
errorstring

DeleteProjectMetadata.LocationProgress

1{
2  "location": "",
3  "resources_total": 0,
4  "resources_deleted": 0,
5  "error": ""
6}

ListProjectsResponse

projectsrepeated Project
Show child attributesHide child attributes
- display_namestringRequired
- accountstringRequired
  Owning account, accounts/{account}. Changing it is a transfer, done through a dedicated flow rather than UpdateProject.
- namestringIdentifier
  projects/{project}.
- project_idstringImmutable
  Short id unique across Plany, e.g. "survival-eu". Appears in resource names and API URLs, so it is immutable once set.
- stateProject.StateOutput only
  STATE_ACTIVESTATE_PENDING_DELETIONSTATE_SUSPENDED
- labelsmap<string, string>
  Labels are copied onto every usage record the project generates, which is how a studio splits one bill across games, environments or customers.
- default_locationstring
  Default location for resources created without an explicit one.
- create_timeTimestampOutput only
- update_timeTimestampOutput only
- purge_timeTimestampOutput only
  When a pending deletion becomes irreversible.
- etagstringOutput only
- active_locationsrepeated stringOutput only
  Locations this project has resources in. Maintained by regional services so that a project-wide delete knows which regions to fan out to without asking every region in the fleet.
next_page_tokenstring

Project

Project groups resources, scopes quota and carries the labels that spend is broken down by.

display_namestringRequired
accountstringRequired
Owning account, accounts/{account}. Changing it is a transfer, done through a dedicated flow rather than UpdateProject.
namestringIdentifier
projects/{project}.
project_idstringImmutable
Short id unique across Plany, e.g. "survival-eu". Appears in resource names and API URLs, so it is immutable once set.
stateProject.StateOutput only
STATE_ACTIVESTATE_PENDING_DELETIONSTATE_SUSPENDED
labelsmap<string, string>
Labels are copied onto every usage record the project generates, which is how a studio splits one bill across games, environments or customers.
default_locationstring
Default location for resources created without an explicit one.
create_timeTimestampOutput only
update_timeTimestampOutput only
purge_timeTimestampOutput only
When a pending deletion becomes irreversible.
etagstringOutput only
active_locationsrepeated stringOutput only
Locations this project has resources in. Maintained by regional services so that a project-wide delete knows which regions to fan out to without asking every region in the fleet.

Enums

Project.State

Value	Description
STATE_UNSPECIFIED
STATE_ACTIVE
STATE_PENDING_DELETION	Deletion requested, inside the retention window. Resources are stopped and billing has ceased, but everything is restorable.
STATE_SUSPENDED	Owning account has no credit. Workloads are stopped; the project itself is untouched and resumes on top-up.