Skip to content

Projects

A project is a scope container — most resources (tags, zones, users) belong to one project. The client carries a default project via project_uid= on construction; with_scope swaps it without re-logging in.

Operations

Method What it does
client.projects.list() All projects the user can see (does NOT require an active project scope).
client.projects.get(uid) One project by uid (filters list() client-side; raises NotFound if absent).
client.projects.create(name, **fields) Create a project.
client.projects.update(uid, **fields) Update fields.
client.projects.delete(uid) Delete.
projects = client.projects.list()
p = client.projects.get(projects[0].uid)
new = client.projects.create(name="Q3 fulfillment")

get exists for convenience only — the server has no single-project endpoint (a path GET 404s and the list ignores a uid filter), so it fetches the visible projects and selects the match in the SDK.

Model — Project

Field Type Notes
uid str Server-assigned.
name str \| None Display.
company_uid str \| None Parent company.

Full field list.

See also

  • Scope switchingclient.with_scope(project_uid=...) and client.use_project(...).