Hubble Network Organizations API

The Organizations API from Hubble Network — 4 operation(s) for organizations.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PATCH /v1/org/{org_id} Update organization details · Update Organization Metadata #

Ask an LLM

“How do I change my organization's name or mailing address?”

“Can I set my organization's timezone?”

Tell an agent

Rename organization {org_id} to {set_name}.

Set the timezone of org {org_id} to {set_timezone}.

GET /v1/org/{org_id} View organization details · Retrieve Organization Metadata #

Ask an LLM

“What name, address and contact info does my organization have on file?”

“Which timezone is my organization set to?”

Tell an agent

Show the metadata for organization {org_id}.

Get the profile details on record for org {org_id}.

GET /v1/org/{org_id}/users List members of an organization · List Organization Users #

Ask an LLM

“Who are the users in my organization?”

“Can I page through the member list a few users at a time?”

Tell an agent

List the users in organization {org_id}.

Show page {page_number} of org {org_id}'s members, {page_size} per page.

POST /v1/org/{org_id}/users Add a user directly to the organization · Add User to Organization #

Ask an LLM

“How do I add someone to my organization right away without sending an invite?”

“Can I choose a user's role at the moment I add them?”

Tell an agent

Add {email} to organization {org_id} directly as {role}.

Put user {email} straight into org {org_id} with the {role} role, no invitation.

PATCH /v1/org/{org_id}/users/{user_id} Change a member's name or role · Update User in Organization #

Ask an LLM

“How do I change an existing member's role in my organization?”

“Can I correct a user's first or last name?”

Tell an agent

Change the role of user {user_id} in org {org_id} to {set_role}.

Update user {user_id} in org {org_id} to first name {set_first_name} and last name {set_last_name}.

DELETE /v1/org/{org_id}/users/{user_id} Remove a user from the organization · Delete User from Organization #

Ask an LLM

“How do I remove a team member who has left the company?”

“Can I take away someone's access to my organization?”

Tell an agent destructive · confirm first

Remove user {user_id} from organization {org_id}.

Revoke member {user_id}'s access to org {org_id}.

GET /v1/org/{org_id}/invitations List pending invitations · List Pending Invites #

Ask an LLM

“Which invitations to my organization haven't been accepted yet?”

“Who have we invited that still hasn't joined?”

Tell an agent

List pending invitations for organization {org_id}.

Show page {page_number} of outstanding invites to org {org_id}.

POST /v1/org/{org_id}/invitations Invite someone to join the organization · Invite User to Organization #

Ask an LLM

“How do I send an invitation for a colleague to join my organization?”

“Can I pick the role an invitee will get once they accept?”

Tell an agent

Invite {invitee_email} to join organization {org_id} as {role}.

Send an invitation to {invitee_email} for org {org_id} with the {role} role.

DELETE /v1/org/{org_id}/invitations Revoke a pending invitation · Delete Invitation #

Ask an LLM

“How do I cancel an invitation I sent to the wrong email address?”

“Can I withdraw an invite before the person accepts it?”

Tell an agent destructive · confirm first

Revoke the pending invitation for {invitee_email} to organization {org_id}.

Cancel the outstanding invite sent to {invitee_email} for org {org_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hubble-network:hubble-network-organizations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Hubble Platform Organizations API
  description: 'The Hubble platform is built API-first. Use our Cloud API to manage your devices

    and access device data programmatically. We''ve designed our API following RESTful principles. Each endpoint returns standard HTTP status codes and may include JSON payloads. ---


    ## API Access

    Use API Keys to authenticate with the Hubble Cloud API for your organization. ### Generate an API Key

    Log in to your Hubble dashboard. Navigate to **Developer Tools > API Tokens** to create a new API Key. Provide a name for the token, and set an appropriate expiration date for temporary access. ### Organization ID

    You will need `org_id` to make API requests. From your Hubble dashboard, navigate to

    **Developer Tooks > API Tokens**, or **Organization Settings**, to find your Organization ID. ### Authorization Scopes

    API endpoints require specific authorization scopes to perform the intended operation. **Required Scope** is always provided in the API documentation. API Keys can be created with specific authorization scopes that control what operations the key can perform. If no scopes are specified, the key will be created with all available scopes (admin-level access). | **Scope** | **Access** |

    |------------------------------|-------------------------------------------------|

    | **read-api-keys** | View API keys and their metadata |

    | **write-api-keys** | Create, update, and delete API keys |

    | **read-users** | View user information and roles |

    | **write-users** | Add, update, and remove users from the organization |

    | **read-organization-metadata** | View organization details and settings |

    | **write-organization-metadata** | Update organization information |

    | **read-devices** | View device information and status |

    | **write-devices** | Register and manage devices |

    | **read-invitations** | View pending invitations |

    | **write-invitations** | Create and revoke user invitations |

    | **read-packets** | Access packet data and retrieval endpoints |

    | **read-platform-metrics** | View platform metrics and analytics |

    | **read-billing-usage** | View billing usage information |

    | **read-billing-invoices** | View billing invoices |

    | **read-webhooks** | View webhook configurations |

    | **write-webhooks** | Create and manage webhook endpoints |

    | **read-satellites** | View satellite ephemeris and pass data |


    **Example Scope Combinations**

    - Create a key with read-only access: `["read-api-keys", "read-users", "read-devices"]`

    - Create a key for device management: `["read-devices", "write-devices"]`

    - Create a key for user management: `["read-users", "write-users", "read-invitations", "write-invitations"]`


    **Best Practices for Data Security**

    - Create keys with the minimum required scopes for your use case

    - Regularly review and rotate API keys

    - Use descriptive names for your keys to track their purpose

    - Set appropriate expiration dates for temporary access


    ---


    ## Import API Definition

    You can quickly import the Hubble Cloud API into your preferred developer environment (such as Postman or Insomnia) using our **public OpenAPI definition**. Simply download or import the YAML file directly:


    https://hubble.com/docs/openapi.yaml


    ---


    ## Pagination

    When the number of objects requested exceeds the maximum page size for an endpoint, the API response will be paginated. This means you will receive a subset of the total results, along with a `Continuation-Token` in the Response Header that can be used to fetch subsequent subsets. To retrieve the next set of data, you must use the provided `Continuation-Token` in the Request Header of your next API call to the same endpoint. Continue using the provided token in each successive request until no `Continuation-Token` is returned, which indicates you have retrieved all available data. ---


    ## Rate Limits

    The Hubble Cloud API follows a leaky bucket approach to rate limiting. Endpoints are rate limited to three (3) requests per second. Your organization is limited to a total of 15 requests per second.'
  version: 1.0.0
servers:
- url: https://api.hubble.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Organizations
paths:
  /v1/org/{org_id}:
    patch:
      tags:
      - Organizations
      operationId: update-organization-metadata
      x-criticality: medium
      summary: Update Organization Metadata
      description: 'Update metadata for an organization.


        **Required Scope:** `write-organization-metadata`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: "All of the potential update operations. \nEach field is optional but the request must have at least one field set to perform an update.\n"
              properties:
                set_name:
                  $ref: '#/components/schemas/organizationName'
                set_address:
                  $ref: '#/components/schemas/address'
                set_contact_info:
                  $ref: '#/components/schemas/contactInfo'
                set_timezone:
                  $ref: '#/components/schemas/timezone'
            example:
              set_address:
                street_address: Your Address
                street_address_line_two: Suite 200
                city: Seattle
                state: WA
                country: '840'
              set_contact_info:
                email: ops@yourdomain.com
                phone_number: '+13334445555'
              set_timezone: Europe/Berlin
      responses:
        '200':
          description: Updated Organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organization'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '413':
          $ref: '#/components/responses/ErrorRequestEntityTooLarge'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    get:
      tags:
      - Organizations
      operationId: retrieve-organization-metadata
      x-criticality: medium
      summary: Retrieve Organization Metadata
      description: 'Retrieve metadata for an organization.


        **Required Scope:** `read-organization-metadata`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      responses:
        '200':
          description: An Organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organization'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
  /v1/org/{org_id}/users:
    get:
      tags:
      - Organizations
      operationId: list-users-in-organization
      x-criticality: medium
      summary: List Organization Users
      description: 'Page through users in an organization.


        **Required Scope:** `read-users`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/pageNumberQueryParam'
      - $ref: '#/components/parameters/pageSizeQueryParam'
      responses:
        '200':
          description: A page of users from an organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/organizationUser'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    post:
      tags:
      - Organizations
      operationId: add-user-to-organization
      x-criticality: medium
      summary: Add User to Organization
      description: 'Add a user to the organization.

        This endpoint directly adds the user to the organization and does not create an invitation.


        **Required Scope:** `write-users`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/contentTypeJsonHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              - role
              properties:
                email:
                  type: string
                  format: email
                  description: Email address of the user to add
                role:
                  $ref: '#/components/schemas/userRole'
                  description: Role to assign to the user in the organization
              example:
                email: newuser@example.com
                role: member
      responses:
        '200':
          description: User added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizationUser'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '413':
          $ref: '#/components/responses/ErrorRequestEntityTooLarge'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
  /v1/org/{org_id}/users/{user_id}:
    patch:
      tags:
      - Organizations
      operationId: update-user-in-organization
      x-criticality: medium
      summary: Update User in Organization
      description: 'Update a user''s metadata and/or role in the organization.


        **Required Scope:** `write-users`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/userIdPathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Request body for updating a user in an organization
              properties:
                set_first_name:
                  type: string
                  maxLength: 250
                  description: Update the user's first name
                set_last_name:
                  type: string
                  maxLength: 250
                  description: Update the user's last name
                set_role:
                  $ref: '#/components/schemas/userRole'
                  description: Update the user's role in the organization
              example:
                set_first_name: John
                set_last_name: Doe
                set_role: admin
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizationUser'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '413':
          $ref: '#/components/responses/ErrorRequestEntityTooLarge'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    delete:
      tags:
      - Organizations
      operationId: delete-user-from-organization
      x-criticality: medium
      summary: Delete User from Organization
      description: 'Remove a user from the organization.


        **Required Scope:** `write-users`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/userIdPathParam'
      responses:
        '200':
          description: User successfully deleted from organization
          content:
            application/json:
              schema:
                type: object
                description: Empty response object
                example: {}
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
  /v1/org/{org_id}/invitations:
    get:
      tags:
      - Organizations
      operationId: list-pending-invites
      x-criticality: medium
      summary: List Pending Invites
      description: 'Page through pending invites to an organization.


        **Required Scope:** `read-invitations`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/pageNumberQueryParam'
      - $ref: '#/components/parameters/pageSizeQueryParam'
      responses:
        '200':
          description: A page of pending invites from an organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  invites:
                    type: array
                    items:
                      $ref: '#/components/schemas/invitation'
                  total_invites:
                    type: integer
                    description: Total number of pending invites
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    post:
      tags:
      - Organizations
      operationId: invite-user-to-organization
      x-criticality: medium
      summary: Invite User to Organization
      description: 'Invite a user to join the organization.


        **Required Scope:** `write-invitations`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/contentTypeJsonHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - invitee_email
              - role
              properties:
                invitee_email:
                  type: string
                  format: email
                  description: Email address of the user to invite
                role:
                  $ref: '#/components/schemas/userRole'
                  description: Role to assign to the invited user
      responses:
        '200':
          description: Invitation successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invitation'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '413':
          $ref: '#/components/responses/ErrorRequestEntityTooLarge'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    delete:
      tags:
      - Organizations
      operationId: delete-invitation
      x-criticality: medium
      summary: Delete Invitation
      description: 'Revoke a pending invitation to the organization.


        **Required Scope:** `write-invitations`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/contentTypeJsonHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - invitee_email
              properties:
                invitee_email:
                  type: string
                  format: email
                  description: Email address of the user whose invitation to revoke
      responses:
        '200':
          description: Invitation successfully revoked
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '413':
          $ref: '#/components/responses/ErrorRequestEntityTooLarge'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
components:
  schemas:
    invitation:
      type: object
      description: An invitation to join an organization
      required:
      - invitee_email
      - role
      - created_at
      - expires_at
      properties:
        invitee_email:
          type: string
          format: email
          description: Email address of the invited user
        inviter_email:
          type: string
          format: email
          description: Email address of the user who sent the invitation
        created_at:
          $ref: '#/components/schemas/utcTimestampInteger'
          description: Timestamp when the invitation was created
        expires_at:
          $ref: '#/components/schemas/utcTimestampInteger'
          description: Timestamp when the invitation expires
        role:
          $ref: '#/components/schemas/userRole'
          description: Role that will be assigned to the invited user
    orgId:
      type: string
      format: uuid
      description: The ID for an organization
    orgType:
      type: string
      enum:
      - starter
      - staging
      - pilot
      - growth
      - scale
      - enterprise
      description: 'The organization''s product/billing tier. Starter and Staging are the

        sandbox-style tiers (Staging is a sandbox paired to a production-tier

        org); Pilot, Growth, Scale, and Enterprise are the production-style

        tiers, with Growth/Scale/Enterprise driven by the org''s Stripe plan.

        '
    utcTimestampInteger:
      type: integer
      format: int64
      description: An UTC second-precision timestamp formatted as an integer
    organization:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/organizationName'
        org_id:
          $ref: '#/components/schemas/orgId'
        contact_info:
          $ref: '#/components/schemas/contactInfo'
        address:
          $ref: '#/components/schemas/address'
        timezone:
          $ref: '#/components/schemas/timezone'
        org_type:
          $ref: '#/components/schemas/orgType'
        production_org_id:
          allOf:
          - $ref: '#/components/schemas/orgId'
          description: 'The org_id of the paired production organization. Only set when

            org_type is staging.

            '
    userRole:
      type: string
      enum:
      - admin
      - member
      description: The role a user is assigned within an organization
    organizationName:
      type: string
      description: The name of the organization
      example: Your Awesome Company Name
    organizationUser:
      type: object
      description: A user within an organization
      properties:
        user_id:
          type: string
          description: an id for the user
        email:
          type: string
          format: email
          description: the user's email address
        email_confirmed:
          type: boolean
          description: whether the user's email has been confirmed
        first_name:
          type: string
          description: the user's first name
        last_name:
          type: string
          description: the user's last name
        created_at:
          $ref: '#/components/schemas/utcTimestampInteger'
        last_active_at:
          $ref: '#/components/schemas/utcTimestampInteger'
        role:
          $ref: '#/components/schemas/userRole'
    contactInfo:
      type: object
      properties:
        phone_number:
          type: string
          description: A phone number matching the [E.164](https://en.wikipedia.org/wiki/E.164) specification
          example: '+13334445555'
        email:
          type: string
          description: An email address
          example: ops@yourdomain.com
    address:
      type: object
      properties:
        street_address:
          type: string
          description: The first line of a street address
          maxLength: 250
          example: Your Address
        street_address_line_two:
          type: string
          description: The optional second line of a street address
          maxLength: 250
          example: Suite 200
        city:
          type: string
          description: A city that the address relates to
          maxLength: 100
          example: Seattle
        state:
          type: string
          description: A state that the address relates to
          maxLength: 100
          example: WA
        country:
          type: string
          description: A country code defined by [ISO-3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
          example: '840'
    errorResponse:
      type: object
      properties:
        code:
          type: integer
          description: The HTTP status code
        description:
          type: string
          description: 'A description for the error.

            For user errors, we attempt to be as descriptive as possible to help with diagnosing the issue.

            For internal errors, the error description is only indicates that a retry should occur but we log the full error so that we can diagnose it.

            Error descriptions can change over time and should not be programmed against.

            '
        name:
          type: string
          enum:
          - Bad Request
          - Unauthorized
          - Not Found
          - Request Entity Too Large
          - Too Many Requests
          - Internal Server Error
          description: '`name` is a short name for the error.

            '
    timezone:
      type: string
      description: A timezone string defined in the [IANA Time Zone](https://www.iana.org/time-zones) database.
      example: Europe/Berlin
  parameters:
    orgIdPathParam:
      name: org_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/orgId'
      description: Your organization ID
    pageSizeQueryParam:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 5
        maximum: 100
        default: 10
      description: The maximum number of items to return in a single request
    pageNumberQueryParam:
      name: page_number
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
      description: The page number of items to return
    userIdPathParam:
      name: user_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: The ID of the user
    contentTypeJsonHeader:
      name: Content-Type
      in: header
      schema:
        type: string
      description: An indication that the payload is JSON
      example: application/json
  responses:
    ErrorBadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 400
            description: The request could not be understood by the server due to malformed syntax.
            name: Bad Request
    ErrorInternalServer:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 500
            description: An unknown error has occurred.
            name: Unknown
    ErrorRequestEntityTooLarge:
      description: Request Entity Too Large
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 413
            description: request body exceeds the maximum allowed size of 1000000 bytes
            name: Request Entity Too Large
    ErrorUnauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 401
            description: Authentication is required and has failed or has not been provided.
            name: Unauthorized
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: Hubble Network
  source: https://hubble.com/docs/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

Hubble Network Organizations API

Operations 9

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification