Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nebulock

Nebulock Entities API

Actors, users, and hosts — the identity/asset correlation graph.

Documentation Provider Profile APIs.io OpenAPI GitHub

Nebulock Entities API is one of 4 APIs that Nebulock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 20 operations across 12 paths. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://api.nebulock.io.

20 operations 12 paths 0 schemas 2 DELETE4 GET6 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.nebulock.io
Authentication
API Key, API Key
Contact
Nebulock
Resource Areas
1

Authentication & Security 2

Nebulock Entities API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key-ID (ApiKeyId). An API key is passed in the header as X-API-Key-Secret (ApiKeySecret). By default, every request must be authenticated.

Paths & Operations 20

Across 12 paths, the API surfaces 20 operations — 2 DELETE, 4 GET, 6 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Entities 20

Actors, users, and hosts — the identity/asset correlation graph.

GET
/public/v1/entities/actors
Retrieve a list of actors from your organization.
get_actors → 200401403404422429
POST
/public/v1/entities/actors
Create a new actor from an ActorCorrelation object.
create_actor → 200401403404422429
GET
/public/v1/entities/actors/{actor_id}
Get one actor by ID with linked users and hosts.
get_actor 1 param → 200401403404422429
PATCH
/public/v1/entities/actors/{actor_id}
Update an actor's description, risklevel, tags, groups or escalation.
update_actor_description 1 param → 200401403404422429
POST
/public/v1/entities/actors/populated
Bulk-create actors with linked users and hosts from flat rows.
create_populated_actors → 200401403404422429
PATCH
/public/v1/entities/actors/{actor_id}/update_search_index
Refresh an actor's keyword search index.
update_actor_search 1 param → 200401403404422429
POST
/public/v1/entities/actors/{actor_id}/users/{user_id}
Link an existing user to an actor.
associate_user_with_actor 2 params → 200401403404422429
PATCH
/public/v1/entities/actors/{actor_id}/users/{user_id}
Update a user linked to an actor.
update_actor_user_api 2 params → 200401403404422429
DELETE
/public/v1/entities/actors/{actor_id}/users/{user_id}
Remove a user from an actor (user record is retained).
unlink_user_from_actor 2 params → 200401403404422429
DELETE
/public/v1/entities/actors/{actor_id}/hosts/{host_id}
Remove a host from an actor (host record is retained).
unlink_host_from_actor 2 params → 200401403404422429
POST
/public/v1/entities/actors/{actor_id}/hosts/{host_id}
Link an existing host to an actor.
associate_host_with_actor 2 params → 200401403404422429
PATCH
/public/v1/entities/actors/{actor_id}/hosts/{host_id}
Update a host linked to an actor.
update_actor_host_api 2 params → 200401403404422429
POST
/public/v1/entities/actors/{actor_id}/new_host
Create a host and link it to an actor.
create_host_for_actor_api 1 param → 200401403404422429
POST
/public/v1/entities/actors/{actor_id}/new_user
Create a user and link it to an actor.
create_user_for_actor_api 1 param → 200401403404422429
PATCH
/public/v1/entities/hosts/{host_id}
Update a host by ID.
update_host_record 1 param → 200401403404422429
GET
/public/v1/entities/users
List identity users for your organization.
get_users → 200401403404422429
POST
/public/v1/entities/users
Create one or more users (JSON array, up to 1000).
create_users → 200401403404422429
PATCH
/public/v1/entities/users/{user_id}
Update a user by ID.
update_user 1 param → 200401403404422429
GET
/public/v1/entities/hosts
List hosts (endpoints or machines) for your organization.
get_hosts → 200401403404422429
POST
/public/v1/entities/hosts
Create one or more hosts (JSON array, up to 1000).
create_hosts → 200401403404422429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nebulock-entities-api-openapi.yml Raw ↑

Other APIs Nebulock publishes across the network.

Nebulock Findings API
AE Profile APIs.io
Nebulock Hunts API
AE Profile APIs.io
Nebulock Rules API
AE Profile APIs.io
#Entities
← Back to N APIs
API Details
ID
nebulock:nebulock-entities-api
Base URL
https://api.nebulock.io
Docs
https://docs.nebulock.io/reference/getting-started-with-the-nebulock-findings-api
Provider
Nebulock
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network