Skip to main content
📣 Try Nexigon today — sign up for a free account, no credit card required. 📣
Nexigon Docs
Documentation

Projects API

Actions in the projects namespace of the Nexigon Hub API.

projects_Query

POST/api/v1/actions/invoke/projects_Query

Query the projects of the instance.

Request QueryProjectsAction

No fields.

Response QueryProjectsOutput

Fields (JSON object)

  • projectsrequired

    List of projects.

    array<QueryProjectsItem>

    Items

    QueryProjectsItem

    Fields (JSON object)

    • projectId(from project_id)required

      ID of the project.

      ProjectIdstring
    • namerequired

      Name of the project.

      string

projects_GetDetails

POST/api/v1/actions/invoke/projects_GetDetails

Get information about a project.

Request GetProjectDetailsAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response GetProjectDetailsOutput

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • namerequired

    Name of the project.

    string
  • deviceCount(from device_count)required

    Number of devices in the project.

    integer

projects_SetName

POST/api/v1/actions/invoke/projects_SetName

Set the name of a project.

Request SetProjectNameAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • namerequired

    New name of the project.

    string

Response Empty

No fields.

projects_Create

POST/api/v1/actions/invoke/projects_Create

Create a new project.

Request CreateProjectAction

Fields (JSON object)

  • organizationId(from organization_id)required

    Organization to create the project in.

    OrganizationIdstring
  • namerequired

    Name of the project.

    string

Response CreateProjectOutput

Casesinternally — tag field result

  • Created

    { "result": "Created", ...<payload fields> } — or "content" for non-object payloads

    CreateProjectSuccess

    Fields (JSON object)

    • projectId(from project_id)required

      ID of the project.

      ProjectIdstring

projects_Delete

POST/api/v1/actions/invoke/projects_Delete

Delete a project.

Request DeleteProjectAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response Empty

No fields.

projects_QueryDevices

POST/api/v1/actions/invoke/projects_QueryDevices

Query the devices of a project.

Request QueryProjectDevicesAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response QueryProjectDevicesOutput

Fields (JSON object)

  • devicesrequired

    List of devices.

    array<QueryProjectDevicesItem>

    Items

    QueryProjectDevicesItem

    Fields (JSON object)

    • deviceId(from device_id)required

      ID of the device.

      DeviceIdstring
    • nameoptional

      Name of the device.

      string
    • hostnameoptional

      Hostname reported by the device (from dev.nexigon.system.info).

      string
    • firstSeen(from first_seen)required

      Timestamp when the device was first seen.

      Timestampstring
    • statusrequired

      Combined device status (connection + health).

      DeviceStatus

      Casesexternally

      • Healthy→ "healthy"

        Device is healthy and connected.

        Value: "healthy"

      • Warning→ "warning"

        Device is connected but experiencing degraded performance.

        Value: "warning"

      • Error→ "error"

        Device is connected but in an error state.

        Value: "error"

      • Offline→ "offline"

        Device is not connected.

        Value: "offline"

    • isConnected(from is_connected)required

      Indicates whether the device is online.

      boolean
    • pendingCertificatesCount(from pending_certificates_count)required

      Pending device certificates.

      integer
    • lastConnectedAt(from last_connected_at)optional

      Timestamp when the device was last connected (current or most recent connection).

      Timestampstring
    • currentConnectionDurationSecs(from current_connection_duration_secs)optional

      Duration of the current connection in seconds (null if not connected).

      integer

projects_QueryDeploymentTokens

POST/api/v1/actions/invoke/projects_QueryDeploymentTokens

Query the deployment tokens of a project.

Request QueryProjectDeploymentTokensAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response QueryProjectDeploymentTokensOutput

Fields (JSON object)

  • tokensrequired

    List of deployment tokens.

    array<QueryProjectDeploymentTokensItem>

    Items

    QueryProjectDeploymentTokensItem

    Fields (JSON object)

    • tokenId(from token_id)required

      ID of the token.

      DeploymentTokenIdstring
    • createdAt(from created_at)required

      Creation date of the token.

      Timestampstring
    • nameoptional

      Name of the token.

      string
    • flagsrequired

      Flags.

      DeploymentTokenFlags

      Fields (JSON object)

      • autoAccept(from auto_accept)optional

        Whether to automatically accept new devices.

        boolean

projects_QueryLinkedRepositories

POST/api/v1/actions/invoke/projects_QueryLinkedRepositories

Query repositories of a project.

Request QueryProjectRepositoriesAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response QueryProjectRepositoriesOutput

Fields (JSON object)

  • repositoriesrequired

    List of repositories.

    array<QueryProjectRepositoriesItem>

    Items

    QueryProjectRepositoriesItem

    Fields (JSON object)

    • repositoryId(from repository_id)required

      ID of the repository.

      RepositoryIdstring
    • publicName(from public_name)required

      Public name of the repository.

      string
    • displayName(from display_name)optional

      Display name of the repository (if any).

      string

projects_CreateDeploymentToken

POST/api/v1/actions/invoke/projects_CreateDeploymentToken

Create a deployment token.

Request CreateDeploymentTokenAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • namerequired

    Name of the token.

    string
  • flagsoptional

    Flags.

    DeploymentTokenFlags

    Fields (JSON object)

    • autoAccept(from auto_accept)optional

      Whether to automatically accept new devices.

      boolean

Response CreateDeploymentTokenOutput

Fields (JSON object)

  • tokenId(from token_id)required

    ID of the token.

    DeploymentTokenIdstring
  • tokenrequired

    Token.

    DeploymentTokenstring

projects_DeleteDeploymentToken

POST/api/v1/actions/invoke/projects_DeleteDeploymentToken

Delete a deployment token.

Request DeleteDeploymentTokenAction

Fields (JSON object)

  • tokenId(from token_id)required

    ID of the token.

    DeploymentTokenIdstring

Response Empty

No fields.

projects_SetDeploymentTokenFlags

POST/api/v1/actions/invoke/projects_SetDeploymentTokenFlags

Set the flags of a deployment token.

Request SetDeploymentTokenFlagsAction

Fields (JSON object)

  • tokenId(from token_id)required

    ID of the token.

    DeploymentTokenIdstring
  • flagsrequired

    Flags.

    DeploymentTokenFlags

    Fields (JSON object)

    • autoAccept(from auto_accept)optional

      Whether to automatically accept new devices.

      boolean

Response Empty

No fields.

projects_QueryAuditLog

POST/api/v1/actions/invoke/projects_QueryAuditLog

Query the audit log of the project.

Request QueryAuditLogEventsAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response QueryAuditLogEventsOutput

Fields (JSON object)

  • eventsrequired

    List of audit log events.

    array<AuditLogEvent>

    Items

    AuditLogEvent

    Fields (JSON object)

    • eventId(from event_id)required

      ID of the audit log event.

      AuditLogEventIdstring
    • actorrequired

      Actor causing the event.

      Actor

      Casesinternally — tag field actor

      • Anonymous

        An anonymous, unauthenticated actor.

        { "actor": "Anonymous", ...<payload fields> } — or "content" for non-object payloads

        AnonymousActor

        No fields.

      • System

        The system itself, typically used for internal actions.

        { "actor": "System", ...<payload fields> } — or "content" for non-object payloads

        SystemActor

        No fields.

      • Device

        A device authenticated via a specific deployment token.

        { "actor": "Device", ...<payload fields> } — or "content" for non-object payloads

        DeviceActor

        Fields (JSON object)

        • deviceId(from device_id)required

          ID of the device.

          DeviceIdstring
        • tokenId(from token_id)required

          ID of the deployment token used for authentication.

          DeploymentTokenIdstring
      • User

        A user typically authenticated via a user session.

        { "actor": "User", ...<payload fields> } — or "content" for non-object payloads

        UserActor

        Fields (JSON object)

        • userId(from user_id)required

          ID of the user.

          UserIdstring
      • UserToken

        A user authenticated via a specific token.

        { "actor": "UserToken", ...<payload fields> } — or "content" for non-object payloads

        UserTokenActor

        Fields (JSON object)

        • userId(from user_id)required

          ID of the user.

          UserIdstring
        • tokenId(from token_id)required

          ID of the user token used for authentication.

          UserTokenIdstring
      • ClusterNode

        A cluster node.

        { "actor": "ClusterNode", ...<payload fields> } — or "content" for non-object payloads

        ClusterNodeActor

        Fields (JSON object)

        • nodeId(from node_id)required

          ID of the cluster node.

          ClusterNodeIdstring
      • OrganizationApiToken

        An organization API token.

        { "actor": "OrganizationApiToken", ...<payload fields> } — or "content" for non-object payloads

        OrganizationApiTokenActor

        Fields (JSON object)

        • organizationId(from organization_id)required

          ID of the organization.

          OrganizationIdstring
        • tokenId(from token_id)required

          ID of the API token.

          OrganizationApiTokenIdstring
    • eventrequired

      Type of the event that was recorded.

      string
    • datarequired

      Additional audit data associated with the event.

      JsonValueany
    • createdAt(from created_at)required

      Timestamp indicating when the audit log event was recorded.

      Timestampstring
    • actionoptional

      Action the event has been caused by (if any).

      AuditLogEventAction

      Fields (JSON object)

      • actionId(from action_id)required

        ID of the action.

        AuditLogActionIdstring
    • joboptional

      Job the event has been caused by (if any).

      AuditLogEventJob

      Fields (JSON object)

      • jobId(from job_id)required

        ID of the job.

        JobIdstring

projects_LinkRepository

POST/api/v1/actions/invoke/projects_LinkRepository

Add a repository to the project.

Request AddProjectRepositoryAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • repositoryId(from repository_id)required

    ID of the repository.

    RepositoryIdstring

Response Empty

No fields.

projects_UnlinkRepository

POST/api/v1/actions/invoke/projects_UnlinkRepository

Remove a repository from the project.

Request RemoveProjectRepositoryAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • repositoryId(from repository_id)required

    ID of the repository.

    RepositoryIdstring

Response Empty

No fields.

projects_GetOtlpConfig

POST/api/v1/actions/invoke/projects_GetOtlpConfig

Get the OTLP event forwarding configuration for a project.

Request GetProjectOtlpConfigAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring

Response GetProjectOtlpConfigOutput

Fields (JSON object)

  • configrequired

    OTLP configuration.

    ProjectOtlpConfig

    Fields (JSON object)

    • enabledrequired

      Whether OTLP forwarding is enabled.

      boolean
    • endpointoptional

      OTLP endpoint URL (e.g., https://otel-collector.example.com/v1/logs).

      string
    • headersrequired

      HTTP headers to include with OTLP requests (e.g., for authentication). Values are masked when read back.

      object<string, string>

      Keys

      string

      Values

      string

projects_SetOtlpConfig

POST/api/v1/actions/invoke/projects_SetOtlpConfig

Set the OTLP event forwarding configuration for a project.

Request SetProjectOtlpConfigAction

Fields (JSON object)

  • projectId(from project_id)required

    ID of the project.

    ProjectIdstring
  • configrequired

    OTLP configuration.

    ProjectOtlpConfig

    Fields (JSON object)

    • enabledrequired

      Whether OTLP forwarding is enabled.

      boolean
    • endpointoptional

      OTLP endpoint URL (e.g., https://otel-collector.example.com/v1/logs).

      string
    • headersrequired

      HTTP headers to include with OTLP requests (e.g., for authentication). Values are masked when read back.

      object<string, string>

      Keys

      string

      Values

      string

Response Empty

No fields.