Projects

projects

ProjectId

Bases: str

Unique ID of a project.

DeploymentTokenId

Bases: str

Unique ID of a deployment token.

DeploymentToken

Bases: str

Deployment token.

QueryProjectsAction

Bases: BaseModel

Query the projects of the instance.

QueryProjectsOutput

Bases: BaseModel

Output of querying the projects of the instance.

projects class-attribute instance-attribute

projects = Field(description='List of projects.')

QueryProjectsItem

Bases: BaseModel

Project item.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the project.')

GetProjectDetailsAction

Bases: BaseModel

Get information about a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

GetProjectDetailsOutput

Bases: BaseModel

Information about a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the project.')

device_count class-attribute instance-attribute

device_count = Field(
    description="Number of devices in the project.",
    validation_alias="deviceCount",
    serialization_alias="deviceCount",
)

SetProjectNameAction

Bases: BaseModel

Set the name of a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='New name of the project.')

CreateProjectAction

Bases: BaseModel

Create a new project.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="Organization to create the project in.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

name class-attribute instance-attribute

name = Field(description='Name of the project.')

CreateProjectSuccess

Bases: BaseModel

Project creation has been successful.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

DeleteProjectAction

Bases: BaseModel

Delete a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryProjectDevicesAction

Bases: BaseModel

Query the devices of a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryProjectDevicesOutput

Bases: BaseModel

Output of querying the devices of a project.

devices class-attribute instance-attribute

devices = Field(description='List of devices.')

QueryProjectDevicesItem

Bases: BaseModel

Device item.

device_id class-attribute instance-attribute

device_id = Field(
    description="ID of the device.",
    validation_alias="deviceId",
    serialization_alias="deviceId",
)

name class-attribute instance-attribute

name = Field(
    default=None, description="Name of the device."
)

first_seen class-attribute instance-attribute

first_seen = Field(
    description="Timestamp when the device was first seen.",
    validation_alias="firstSeen",
    serialization_alias="firstSeen",
)

status class-attribute instance-attribute

status = Field(
    description="Combined device status (connection + health)."
)

is_connected class-attribute instance-attribute

is_connected = Field(
    description="Indicates whether the device is online.",
    validation_alias="isConnected",
    serialization_alias="isConnected",
)

pending_certificates_count class-attribute instance-attribute

pending_certificates_count = Field(
    description="Pending device certificates.",
    validation_alias="pendingCertificatesCount",
    serialization_alias="pendingCertificatesCount",
)

last_connected_at class-attribute instance-attribute

last_connected_at = Field(
    default=None,
    description="Timestamp when the device was last connected (current or most recent connection).",
    validation_alias="lastConnectedAt",
    serialization_alias="lastConnectedAt",
)

current_connection_duration_secs class-attribute instance-attribute

current_connection_duration_secs = Field(
    default=None,
    description="Duration of the current connection in seconds (null if not connected).",
    validation_alias="currentConnectionDurationSecs",
    serialization_alias="currentConnectionDurationSecs",
)

QueryProjectDeploymentTokensAction

Bases: BaseModel

Query the deployment tokens of a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryProjectDeploymentTokensOutput

Bases: BaseModel

Output of querying the deployment tokens of a project.

tokens class-attribute instance-attribute

tokens = Field(description='List of deployment tokens.')

QueryProjectDeploymentTokensItem

Bases: BaseModel

Deployment token item.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Creation date of the token.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

name class-attribute instance-attribute

name = Field(default=None, description="Name of the token.")

flags class-attribute instance-attribute

flags = Field(description='Flags.')

QueryProjectRepositoriesAction

Bases: BaseModel

Query repositories of a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryProjectRepositoriesOutput

Bases: BaseModel

Output of querying the repositories of a project.

repositories class-attribute instance-attribute

repositories = Field(description='List of repositories.')

QueryProjectRepositoriesItem

Bases: BaseModel

Repository item.

repository_id class-attribute instance-attribute

repository_id = Field(
    description="ID of the repository.",
    validation_alias="repositoryId",
    serialization_alias="repositoryId",
)

public_name class-attribute instance-attribute

public_name = Field(
    description="Public name of the repository.",
    validation_alias="publicName",
    serialization_alias="publicName",
)

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Display name of the repository (if any).",
    validation_alias="displayName",
    serialization_alias="displayName",
)

DeploymentTokenFlags

Bases: BaseModel

Flags for deployment tokens.

auto_accept class-attribute instance-attribute

auto_accept = Field(
    default=None,
    description="Whether to automatically accept new devices.",
    validation_alias="autoAccept",
    serialization_alias="autoAccept",
)

CreateDeploymentTokenAction

Bases: BaseModel

Create a deployment token.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the token.')

flags class-attribute instance-attribute

flags = Field(default=None, description='Flags.')

CreateDeploymentTokenOutput

Bases: BaseModel

Output of creating a deployment token.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

token class-attribute instance-attribute

token = Field(description='Token.')

DeleteDeploymentTokenAction

Bases: BaseModel

Delete a deployment token.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

SetDeploymentTokenFlagsAction

Bases: BaseModel

Set the flags of a deployment token.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

flags class-attribute instance-attribute

flags = Field(description='Flags.')

QueryAuditLogEventsAction

Bases: BaseModel

Query the audit log of the project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryAuditLogEventsOutput

Bases: BaseModel

Output of querying the audit log of the project.

events class-attribute instance-attribute

events = Field(description='List of audit log events.')

AddProjectRepositoryAction

Bases: BaseModel

Add a repository to the project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

repository_id class-attribute instance-attribute

repository_id = Field(
    description="ID of the repository.",
    validation_alias="repositoryId",
    serialization_alias="repositoryId",
)

RemoveProjectRepositoryAction

Bases: BaseModel

Remove a repository from the project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

repository_id class-attribute instance-attribute

repository_id = Field(
    description="ID of the repository.",
    validation_alias="repositoryId",
    serialization_alias="repositoryId",
)

ProjectOtlpConfig

Bases: BaseModel

OTLP event forwarding configuration for a project.

enabled class-attribute instance-attribute

enabled = Field(
    description="Whether OTLP forwarding is enabled."
)

endpoint class-attribute instance-attribute

endpoint = Field(
    default=None,
    description="OTLP endpoint URL (e.g., https://otel-collector.example.com/v1/logs).",
)

headers class-attribute instance-attribute

headers = Field(
    description="HTTP headers to include with OTLP requests (e.g., for authentication).\nValues are masked when read back."
)

GetProjectOtlpConfigAction

Bases: BaseModel

Get the OTLP event forwarding configuration for a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

GetProjectOtlpConfigOutput

Bases: BaseModel

Output of getting the OTLP configuration for a project.

config class-attribute instance-attribute

config = Field(description='OTLP configuration.')

SetProjectOtlpConfigAction

Bases: BaseModel

Set the OTLP event forwarding configuration for a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

config class-attribute instance-attribute

config = Field(description='OTLP configuration.')

CreateProjectOutput_Created

Bases: CreateProjectSuccess

result class-attribute instance-attribute

result = 'Created'

CreateProjectOutput

CreateProjectOutput = CreateProjectOutput_Created