NetBox Labs

NetBox Labs ipam API

The ipam API from NetBox Labs — 41 operation(s) for ipam.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/authentication/netbox-labs-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-ipam-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/errors/netbox-labs-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/conventions/netbox-labs-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/data-model/netbox-labs-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/conformance/netbox-labs-conformance.yml

OpenAPI Specification

netbox-labs-ipam-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: NetBox REST authentication-check ipam API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: ipam
paths:
  /api/ipam/aggregates/:
    get:
      operationId: ipam_aggregates_list
      description: Get a list of aggregate objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: contact
        schema:
          type: array
          items:
            type: integer
        description: Contact
        explode: true
        style: form
      - in: query
        name: contact__n
        schema:
          type: array
          items:
            type: integer
        description: Contact
        explode: true
        style: form
      - in: query
        name: contact_group
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: contact_group__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: contact_role
        schema:
          type: array
          items:
            type: integer
        description: Contact Role
        explode: true
        style: form
      - in: query
        name: contact_role__n
        schema:
          type: array
          items:
            type: integer
        description: Contact Role
        explode: true
        style: form
      - in: query
        name: created
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: date_added
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: date_added__empty
        schema:
          type: boolean
      - in: query
        name: date_added__gt
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: date_added__gte
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: date_added__lt
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: date_added__lte
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: date_added__n
        schema:
          type: array
          items:
            type: string
            format: date
        explode: true
        style: form
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: family
        schema:
          type: number
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__empty
        schema:
          type: boolean
      - in: query
        name: id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: last_updated
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: modified_by_request
        schema:
          type: string
          format: uuid
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner__n
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner_group
        schema:
          type: array
          items:
            type: string
        description: Owner Group (name)
        explode: true
        style: form
      - in: query
        name: owner_group__n
        schema:
          type: array
          items:
            type: string
        description: Owner Group (name)
        explode: true
        style: form
      - in: query
        name: owner_group_id
        schema:
          type: array
          items:
            type: integer
        description: Owner Group (ID)
        explode: true
        style: form
      - in: query
        name: owner_group_id__n
        schema:
          type: array
          items:
            type: integer
        description: Owner Group (ID)
        explode: true
        style: form
      - in: query
        name: owner_id
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: owner_id__n
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: prefix
        schema:
          type: string
        description: Prefix
      - in: query
        name: q
        schema:
          type: string
        description: Search
      - in: query
        name: rir
        schema:
          type: array
          items:
            type: string
        description: RIR (slug)
        explode: true
        style: form
      - in: query
        name: rir__n
        schema:
          type: array
          items:
            type: string
        description: RIR (slug)
        explode: true
        style: form
      - in: query
        name: rir_id
        schema:
          type: array
          items:
            type: integer
        description: RIR (ID)
        explode: true
        style: form
      - in: query
        name: rir_id__n
        schema:
          type: array
          items:
            type: integer
        description: RIR (ID)
        explode: true
        style: form
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      - in: query
        name: tag
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag_id
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: tag_id__n
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: tenant
        schema:
          type: array
          items:
            type: string
        description: Tenant (slug)
        explode: true
        style: form
      - in: query
        name: tenant__n
        schema:
          type: array
          items:
            type: string
        description: Tenant (slug)
        explode: true
        style: form
      - in: query
        name: tenant_group
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tenant_group__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tenant_group_id
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tenant_group_id__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tenant_id
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Tenant (ID)
        explode: true
        style: form
      - in: query
        name: tenant_id__n
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Tenant (ID)
        explode: true
        style: form
      - in: query
        name: updated_by_request
        schema:
          type: string
          format: uuid
      tags:
      - ipam
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAggregateList'
          description: ''
    post:
      operationId: ipam_aggregates_create
      description: Post a list of aggregate objects.
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableAggregateRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableAggregateRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableAggregateRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableAggregateRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Aggregate'
          description: ''
    put:
      operationId: ipam_aggregates_bulk_update
      description: Put a list of aggregate objects.
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkAggregateRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkAggregateRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Aggregate'
          description: ''
    patch:
      operationId: ipam_aggregates_bulk_partial_update
      description: Patch a list of aggregate objects.
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkAggregateRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkAggregateRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Aggregate'
          description: ''
    delete:
      operationId: ipam_aggregates_bulk_destroy
      description: Delete a list of aggregate objects.
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AggregateRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AggregateRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/ipam/aggregates/{id}/:
    get:
      operationId: ipam_aggregates_retrieve
      description: Get a aggregate object.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aggregate.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - ipam
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Aggregate'
          description: ''
    put:
      operationId: ipam_aggregates_update
      description: Put a aggregate object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aggregate.
        required: true
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableAggregateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableAggregateRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Aggregate'
          description: ''
    patch:
      operationId: ipam_aggregates_partial_update
      description: Patch a aggregate object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aggregate.
        required: true
      tags:
      - ipam
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWritableAggregateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWritableAggregateRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Aggregate'
          description: ''
    delete:
      operationId: ipam_aggregates_destroy
      description: Delete a aggregate object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aggregate.
        required: true
      tags:
      - ipam
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/ipam/asn-ranges/:
    get:
      operationId: ipam_asn_ranges_list
      description: Get a list of ASN range objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: created
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: end
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: end__empty
        schema:
          type: boolean
      - in: query
        name: end__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: end__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: end__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: end__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: end__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__empty
        schema:
          type: boolean
      - in: query
        name: id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: last_updated
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: modified_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: name
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__empty
        schema:
          type: boolean
      - in: query
        name: name__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tag

# --- truncated at 32 KB (642 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-ipam-api-openapi.yml