Projects
Actions in the projects namespace of the Nexigon Hub API.
Badges mark actions of the Device API and the Admin API, whose compatibility differs from other actions.
projects_Query
POST/api/v1/actions/invoke/projects_QueryAdmin API
Query the projects of the instance.
Request QueryProjectsAction
No fields. Send an empty JSON object.
Response QueryProjectsOutput
projectsarray<object>QueryProjectsItemList of projects.
2 fields
projectIdstringProjectIdID of the project.
namestringName of the project.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_Query{
"projects": [
{
"projectId": "<project-id>",
"name": "<name>"
}
]
}projects_GetDetails
POST/api/v1/actions/invoke/projects_GetDetails
Get information about a project.
Request GetProjectDetailsAction
projectIdstringProjectIdID of the project.
Response GetProjectDetailsOutput
projectIdstringProjectIdID of the project.
namestringName of the project.
deviceCountintegerNumber of devices in the project.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_GetDetails{
"projectId": "<project-id>",
"name": "<name>",
"deviceCount": 1
}projects_SetName
POST/api/v1/actions/invoke/projects_SetName
Set the name of a project.
Request SetProjectNameAction
projectIdstringProjectIdID of the project.
namestringNew name of the project.
- Project name must be between 1 and 128 characters.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>","name":"<name>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_SetName{}projects_Create
POST/api/v1/actions/invoke/projects_Create
Create a new project.
Request CreateProjectAction
organizationIdstringOrganizationIdOrganization to create the project in.
namestringName of the project.
- Project name must be between 1 and 128 characters.
Response CreateProjectOutput
One of the following, identified by result:
result: "Created"projectIdstringProjectIdID of the project.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"organizationId":"<organization-id>","name":"<name>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_Create{
"result": "Created",
"projectId": "<project-id>"
}projects_Delete
POST/api/v1/actions/invoke/projects_Delete
Delete a project.
Request DeleteProjectAction
projectIdstringProjectIdID of the project.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_Delete{}projects_QueryPropertySchemas
POST/api/v1/actions/invoke/projects_QueryPropertySchemas
List project definitions and the read-only built-in definitions.
Request QueryPropertySchemasAction
projectIdstringProjectIdID of the project.
Response QueryPropertySchemasOutput
schemasarray<object>PropertySchemaAvailable definitions.
3 fields
namestringExact property name.
schemaanyJsonValueJSON Schema document.
builtinbooleanWhether the definition is built in and cannot be changed or removed.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryPropertySchemas{
"schemas": [
{
"name": "<name>",
"schema": {},
"builtin": true
}
]
}projects_SetPropertySchema
POST/api/v1/actions/invoke/projects_SetPropertySchema
Create or replace a project schema without validating existing property values.
Requires permission to manage project settings. Built-in definitions are read-only. The schema must be a JSON object or boolean. Editors report unsupported or invalid schemas and allow explicit overrides; APIs do not enforce schemas on property writes.
Request SetPropertySchemaAction
projectIdstringProjectIdID of the project.
namestringExact property name.
- Property name must be between 1 and 256 characters.
- Property name must start with a letter or digit and contain only letters, digits, dots, underscores, or hyphens.
schemaanyJsonValueJSON Schema document.
Nexigon Hub rejects schemas larger than the instance's limit, 64 KiB by default.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>","name":"<name>","schema":{}}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_SetPropertySchema{}projects_RemovePropertySchema
POST/api/v1/actions/invoke/projects_RemovePropertySchema
Remove a project definition without changing property values.
Requires permission to manage project settings. Built-in definitions are read-only.
Request RemovePropertySchemaAction
projectIdstringProjectIdID of the project.
namestringExact property name.
- Property name must be between 1 and 256 characters.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>","name":"<name>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_RemovePropertySchema{}projects_QueryDevices
POST/api/v1/actions/invoke/projects_QueryDevices
Query a page of the devices of a project, newest first.
Request QueryProjectDevicesAction
projectIdstringProjectIdID of the project.
filterobjectDeviceFilteroptionalOnly return devices matching this filter.
4 fields
searchstringoptionalCase-insensitive substring of device name, hostname, or ID.
statusstringDeviceStatusoptionalCurrent combined health and connection status.
"healthy"Device is healthy and connected.
"warning"Device is connected but experiencing degraded performance.
"error"Device is connected but in an error state.
"offline"Device is not connected.
groupsobjectDeviceGroupSelectoroptionalGroup membership conditions.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
profilestringDeviceProfileIdoptional- Unstable (feature
device_profiles)
Only devices that apply this profile.
- Unstable (feature
pageobjectPageRequestoptionalPage to return. Without this field, the first page is returned.
2 fields
limitintegeroptionalMaximum number of items. The default depends on the endpoint and the ceiling is configured by the Hub operator (1000 by default).
- Page limit must be positive.
cursorstringPageCursoroptionalContinue the same endpoint, scope, filters, and ordering.
Response QueryProjectDevicesOutput
devicesarray<object>QueryProjectDevicesItemDevices on this page.
10 fields
groupsarray<object>DeviceGroupGroups currently assigned to this device.
5 fields
groupIdstringDeviceGroupIdprojectIdstringProjectIdnamestringUnique within the project, ignoring case and surrounding whitespace.
colorstringDeviceGroupColoroptional- Group color must be a six-digit hexadecimal color, such as #3b82f6.
descriptionstringoptional
deviceIdstringDeviceIdID of the device.
namestringoptionalName of the device.
hostnamestringoptionalHostname reported by the device (from
dev.nexigon.system.info).firstSeenstring (date-time)TimestampTimestamp when the device was first seen.
statusstringDeviceStatusCombined device status (connection + health).
"healthy"Device is healthy and connected.
"warning"Device is connected but experiencing degraded performance.
"error"Device is connected but in an error state.
"offline"Device is not connected.
isConnectedbooleanIndicates whether the device is online.
pendingCertificatesCountintegerPending device certificates.
lastConnectedAtstring (date-time)TimestampoptionalTimestamp when the device was last connected (current or most recent connection).
currentConnectionDurationSecsintegeroptionalDuration of the current connection in seconds (null if not connected).
pageobjectPageInfoContinuation of the traversal.
1 field
nextCursorstringPageCursoroptionalCursor for the next page; absent when no more matching rows were visible.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryDevices{
"devices": [
{
"groups": [
{
"groupId": "<device-group-id>",
"projectId": "<project-id>",
"name": "<name>"
}
],
"deviceId": "<device-id>",
"firstSeen": "2026-01-01T12:00:00Z",
"status": "healthy",
"isConnected": true,
"pendingCertificatesCount": 1
}
],
"page": {}
}projects_CountDevices
POST/api/v1/actions/invoke/projects_CountDevices
Count the devices of a project.
Request CountProjectDevicesAction
projectIdstringProjectIdID of the project.
filterobjectDeviceFilteroptionalOnly count devices matching this filter in
matching.4 fields
searchstringoptionalCase-insensitive substring of device name, hostname, or ID.
statusstringDeviceStatusoptionalCurrent combined health and connection status.
"healthy"Device is healthy and connected.
"warning"Device is connected but experiencing degraded performance.
"error"Device is connected but in an error state.
"offline"Device is not connected.
groupsobjectDeviceGroupSelectoroptionalGroup membership conditions.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
profilestringDeviceProfileIdoptional- Unstable (feature
device_profiles)
Only devices that apply this profile.
- Unstable (feature
Response CountProjectDevicesOutput
totalintegerNumber of devices in the project.
matchingintegerNumber of devices matching the filter.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_CountDevices{
"total": 1,
"matching": 1
}projects_QueryDeploymentTokens
POST/api/v1/actions/invoke/projects_QueryDeploymentTokens
Query the deployment tokens of a project.
Request QueryProjectDeploymentTokensAction
projectIdstringProjectIdID of the project.
Response QueryProjectDeploymentTokensOutput
tokensarray<object>QueryProjectDeploymentTokensItemList of deployment tokens.
5 fields
tokenIdstringDeploymentTokenIdID of the token.
deviceIdstringDeviceIdoptionalDevice this deployment token is bound to, if any.
createdAtstring (date-time)TimestampCreation date of the token.
namestringoptionalName of the token.
flagsobjectDeploymentTokenFlagsFlags.
1 field
autoAcceptbooleanoptionalWhether to automatically accept new devices.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryDeploymentTokens{
"tokens": [
{
"tokenId": "<deployment-token-id>",
"createdAt": "2026-01-01T12:00:00Z",
"flags": {}
}
]
}projects_QueryLinkedRepositories
POST/api/v1/actions/invoke/projects_QueryLinkedRepositories
Query repositories of a project.
Request QueryProjectRepositoriesAction
projectIdstringProjectIdID of the project.
Response QueryProjectRepositoriesOutput
repositoriesarray<object>QueryProjectRepositoriesItemList of repositories.
5 fields
repositoryIdstringRepositoryIdID of the repository.
displayNamestringDisplay name of the repository.
pathNamestringoptionalPath name of the repository, unique within its organization.
Absent on older Hub versions.
slugstringoptionalSlug of the repository, unique on the instance, if one has been set.
publicNamestring- Deprecated β removed in
2029.2β Useslug, which is absent when no slug is set.
Public name of the repository.
Falls back to the repository ID when no slug is set.
- Deprecated β removed in
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryLinkedRepositories{
"repositories": [
{
"repositoryId": "<repository-id>",
"displayName": "<display-name>",
"publicName": "<public-name>"
}
]
}projects_CreateDeploymentToken
POST/api/v1/actions/invoke/projects_CreateDeploymentToken
Create a deployment token.
Request CreateDeploymentTokenAction
projectIdstringProjectIdID of the project.
namestringName of the token.
- Token name must be between 1 and 128 characters.
flagsobjectDeploymentTokenFlagsoptionalFlags.
1 field
autoAcceptbooleanoptionalWhether to automatically accept new devices.
Response CreateDeploymentTokenOutput
tokenIdstringDeploymentTokenIdID of the token.
tokenstringDeploymentTokenToken.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>","name":"<name>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_CreateDeploymentToken{
"tokenId": "<deployment-token-id>",
"token": "<deployment-token>"
}projects_DeleteDeploymentToken
POST/api/v1/actions/invoke/projects_DeleteDeploymentToken
Delete a deployment token.
Request DeleteDeploymentTokenAction
tokenIdstringDeploymentTokenIdID of the token.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tokenId":"<deployment-token-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_DeleteDeploymentToken{}projects_SetDeploymentTokenFlags
POST/api/v1/actions/invoke/projects_SetDeploymentTokenFlags
Set the flags of a deployment token.
Request SetDeploymentTokenFlagsAction
tokenIdstringDeploymentTokenIdID of the token.
flagsobjectDeploymentTokenFlagsFlags.
1 field
autoAcceptbooleanoptionalWhether to automatically accept new devices.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tokenId":"<deployment-token-id>","flags":{}}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_SetDeploymentTokenFlags{}projects_QueryDevicePairingKeys
POST/api/v1/actions/invoke/projects_QueryDevicePairingKeys
Query the device pairing keys of a project.
Request QueryDevicePairingKeysAction
projectIdstringProjectIdID of the project.
Response QueryDevicePairingKeysOutput
pairingKeysarray<object>QueryDevicePairingKeysItemList of device pairing keys.
9 fields
pairingKeyIdstringDevicePairingKeyIdID of the pairing key.
selectorstringPublic lookup selector (first six normalized characters of the key).
createdAtstring (date-time)TimestampCreation date of the pairing key.
expiresAtstring (date-time)TimestampExpiration date of the pairing key.
usedAtstring (date-time)TimestampoptionalTimestamp when the pairing key was redeemed.
revokedAtstring (date-time)TimestampoptionalTimestamp when the pairing key was revoked.
namestringoptionalName of the pairing key.
deviceIdstringDeviceIdoptionalDevice created or associated when the pairing key was redeemed.
tokenIdstringDeploymentTokenIdoptionalDeployment token issued when the pairing key was redeemed.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryDevicePairingKeys{
"pairingKeys": [
{
"pairingKeyId": "<device-pairing-key-id>",
"selector": "<selector>",
"createdAt": "2026-01-01T12:00:00Z",
"expiresAt": "2026-01-01T12:00:00Z"
}
]
}projects_CreateDevicePairingKey
POST/api/v1/actions/invoke/projects_CreateDevicePairingKey
Create a device pairing key.
Request CreateDevicePairingKeyAction
projectIdstringProjectIdID of the project.
namestringoptionalName of the pairing key.
- Pairing key name must be between 1 and 128 characters.
validForSecsintegeroptionalPairing key validity duration in seconds.
Defaults to 5 minutes. The maximum is 10 minutes.
- Pairing key validity must be between 1 second and 10 minutes.
Response CreateDevicePairingKeyOutput
pairingKeyIdstringDevicePairingKeyIdID of the pairing key.
pairingKeystringPairing key. This is only returned once.
selectorstringPublic lookup selector (first six normalized characters of the key).
createdAtstring (date-time)TimestampCreation date of the pairing key.
expiresAtstring (date-time)TimestampExpiration date of the pairing key.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_CreateDevicePairingKey{
"pairingKeyId": "<device-pairing-key-id>",
"pairingKey": "<pairing-key>",
"selector": "<selector>",
"createdAt": "2026-01-01T12:00:00Z",
"expiresAt": "2026-01-01T12:00:00Z"
}projects_RevokeDevicePairingKey
POST/api/v1/actions/invoke/projects_RevokeDevicePairingKey
Revoke an unused device pairing key.
Request RevokeDevicePairingKeyAction
pairingKeyIdstringDevicePairingKeyIdID of the pairing key.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"pairingKeyId":"<device-pairing-key-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_RevokeDevicePairingKey{}projects_RedeemDevicePairingKey
POST/api/v1/actions/invoke/projects_RedeemDevicePairingKeyDevice API
Redeem a device pairing key.
Creates a device in the pairing key's project and issues a deployment token bound to it. The device uses the token to connect to Nexigon Hub. This action does not require authentication; the pairing key authorizes it.
Request RedeemDevicePairingKeyAction
pairingKeystringPairing key as shown to the user.
- Pairing key must be 10 characters, optionally formatted with one dash.
fingerprintstringDeviceFingerprintFingerprint generated by the device.
deviceNamestringoptionalOptional display name for the device.
- Device name must be between 1 and 128 characters.
Response RedeemDevicePairingKeyOutput
projectIdstringProjectIdProject the device was created in.
deviceIdstringDeviceIdDevice created for this pairing key.
tokenIdstringDeploymentTokenIdID of the issued device-bound deployment token.
tokenstringDeploymentTokenDevice-bound deployment token. This is only returned once.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pairingKey": "<pairing-key>",
"fingerprint": "<device-fingerprint>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_RedeemDevicePairingKey{
"projectId": "<project-id>",
"deviceId": "<device-id>",
"tokenId": "<deployment-token-id>",
"token": "<deployment-token>"
}projects_QueryAuditLog
POST/api/v1/actions/invoke/projects_QueryAuditLog
Query the audit log of the project.
Request QueryAuditLogEventsAction
pageobjectPageRequestoptionalOpt into cursor pagination. Without this field, the existing limit applies.
2 fields
limitintegeroptionalMaximum number of items. The default depends on the endpoint and the ceiling is configured by the Hub operator (1000 by default).
- Page limit must be positive.
cursorstringPageCursoroptionalContinue the same endpoint, scope, filters, and ordering.
projectIdstringProjectIdID of the project.
Response QueryAuditLogEventsOutput
pageobjectPageInfooptionalPresent when cursor pagination was requested.
1 field
nextCursorstringPageCursoroptionalCursor for the next page; absent when no more matching rows were visible.
eventsarray<object>AuditLogEventList of audit log events.
7 fields
eventIdstringAuditLogEventIdID of the audit log event.
actorobjectActorActor causing the event.
7 variants
One of the following, identified by
actor:actor: "Anonymous"An anonymous, unauthenticated actor.
actor: "System"The system itself, typically used for internal actions.
actor: "Device"A device authenticated via a specific deployment token.
deviceIdstringDeviceIdID of the device.
tokenIdstringDeploymentTokenIdID of the deployment token used for authentication.
actor: "User"A user typically authenticated via a user session.
userIdstringUserIdID of the user.
actor: "UserToken"A user authenticated via a specific token.
userIdstringUserIdID of the user.
tokenIdstringUserTokenIdID of the user token used for authentication.
actor: "ClusterNode"A cluster node.
nodeIdstringClusterNodeIdID of the cluster node.
actor: "OrganizationApiToken"An organization API token.
organizationIdstringOrganizationIdID of the organization.
tokenIdstringOrganizationApiTokenIdID of the API token.
eventstringType of the event that was recorded.
dataanyJsonValueAdditional audit data associated with the event.
createdAtstring (date-time)TimestampTimestamp indicating when the audit log event was recorded.
actionobjectAuditLogEventActionoptionalAction the event has been caused by (if any).
1 field
actionIdstringAuditLogActionIdID of the action.
jobobjectAuditLogEventJoboptionalJob the event has been caused by (if any).
1 field
jobIdstringJobIdID of the job.
referencesobjectAuditLogReferencesoptionalNames of the actors of the returned events.
Absent in responses of Nexigon Hub 2026.3 and earlier.
3 fields
usersarray<object>AuditLogUserReferenceUsers acting directly or through a user token.
3 fields
userIdstringUserIdID of the user.
displayNamestringoptionalName of the user.
emailstringEmail of the user.
devicesarray<object>AuditLogDeviceReferenceDevices.
2 fields
deviceIdstringDeviceIdID of the device.
namestringName of the device.
organizationApiTokensarray<object>AuditLogOrganizationApiTokenReferenceOrganization API tokens.
2 fields
tokenIdstringOrganizationApiTokenIdID of the API token.
namestringName of the API token.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_QueryAuditLog{
"events": [
{
"eventId": "<audit-log-event-id>",
"actor": {
"actor": "Device",
"deviceId": "<device-id>",
"tokenId": "<deployment-token-id>"
},
"event": "<event>",
"data": {},
"createdAt": "2026-01-01T12:00:00Z"
}
]
}projects_LinkRepository
POST/api/v1/actions/invoke/projects_LinkRepository
Add a repository to the project.
The repository must belong to the project's organization.
Request AddProjectRepositoryAction
projectIdstringProjectIdID of the project.
repositoryIdstringRepositoryIdID of the repository.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"repositoryId": "<repository-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_LinkRepository{}projects_UnlinkRepository
POST/api/v1/actions/invoke/projects_UnlinkRepository
Remove a repository from the project.
Request RemoveProjectRepositoryAction
projectIdstringProjectIdID of the project.
repositoryIdstringRepositoryIdID of the repository.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"repositoryId": "<repository-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_UnlinkRepository{}projects_GetOtlpConfig
POST/api/v1/actions/invoke/projects_GetOtlpConfig
- Unstable (feature
otlp_export)
Get the OTLP event forwarding configuration for a project.
Request GetProjectOtlpConfigAction
projectIdstringProjectIdID of the project.
Response GetProjectOtlpConfigOutput
configobjectProjectOtlpConfigOTLP configuration.
3 fields
enabledbooleanWhether OTLP forwarding is enabled.
endpointstringoptionalOTLP endpoint URL (e.g., https://otel-collector.example.com/v1/logs).
- OTLP endpoint must be between 1 and 2048 characters.
- OTLP endpoint must be an HTTP(S) URL.
headersmap<string, string>HTTP headers to include with OTLP requests (e.g., for authentication). Values are masked when read back. Setting a header to its masked value keeps the stored value, provided that the endpoint stays the same.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_GetOtlpConfig{
"config": {
"enabled": true,
"headers": {
"<key>": "<string>"
}
}
}projects_SetOtlpConfig
POST/api/v1/actions/invoke/projects_SetOtlpConfig
- Unstable (feature
otlp_export)
Set the OTLP event forwarding configuration for a project.
Request SetProjectOtlpConfigAction
projectIdstringProjectIdID of the project.
configobjectProjectOtlpConfigOTLP configuration.
3 fields
enabledbooleanWhether OTLP forwarding is enabled.
endpointstringoptionalOTLP endpoint URL (e.g., https://otel-collector.example.com/v1/logs).
- OTLP endpoint must be between 1 and 2048 characters.
- OTLP endpoint must be an HTTP(S) URL.
headersmap<string, string>HTTP headers to include with OTLP requests (e.g., for authentication). Values are masked when read back. Setting a header to its masked value keeps the stored value, provided that the endpoint stays the same.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"config": {
"enabled": true,
"headers": {
"<key>": "<string>"
}
}
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/projects_SetOtlpConfig{}