OptixLog Docs
API ReferenceManagement

ManagementProject

The ManagementProject handle — attributes for config, organization, teams, workflow nodes, and audit events, plus get_all_members and snapshot methods.

ManagementProject is a lightweight handle scoped to a single project. You obtain it from Management.project() or Management.project_from(). It exposes collection attributes for every resource and two convenience methods.

proj = mgmt.project("proj_grating_7f3a")

Attributes

Prop

Type


ProjectConfigResource.get()

Fetch the project's configuration record.

Signature

def get(self) -> ProjectConfig: ...

Parameters — None.

Returns — ProjectConfig: a frozen dataclass with the following fields:

Prop

Type

ProjectConfig also exposes .to_dict() -> dict which returns all fields with created_at/updated_at as ISO strings.

Side effects — Makes one HTTP read request to the server.

Raises — NotFoundError when no config exists for the project. AuthenticationError when the API key is invalid or missing.

Example

config = proj.config.get()
print(config.name, config.status)
print(config.to_dict())

ProjectOrganizationResource.get()

Fetch the organization that owns the project.

Signature

def get(self) -> Organization: ...

Parameters — None.

Returns — Organization: a frozen dataclass with the following fields:

Prop

Type

Side effects — Makes one HTTP read request to the server.

Raises — NotFoundError when no organization record exists for the project. AuthenticationError when the API key is invalid or missing.

Example

org = proj.organization.get()
print(org.name, org.industry)

ManagementProject.get_all_members(...)

Return a paginated list of all members across all teams in the project.

See the dedicated Members API page for full documentation.

Signature

def get_all_members(
    self,
    *,
    include_memberships: bool = False,
    limit: int = 100,
    cursor: str | None = None,
    order_by: MemberOrderBy = "name",
    order: Literal["asc", "desc"] = "asc",
) -> Page[ProjectMember]: ...

ManagementProject.snapshot(...)

Fetch multiple resources in a single coordinated call and return a ProjectSnapshot.

See the dedicated Snapshot API page for full documentation.

Signature

def snapshot(
    self,
    *,
    include: Sequence[
        Literal[
            "config",
            "organization",
            "teams",
            "members",
            "workflow_nodes",
            "audit_events",
        ]
    ],
    team_limit: int = 100,
    member_limit: int = 100,
    node_limit: int = 100,
    audit_limit: int = 100,
) -> ProjectSnapshot: ...

On this page