Tenable Agent Exclusions API

The Agent Exclusions API from Tenable — 2 operation(s) for agent exclusions.

Business capability
Vulnerability Management BC-620.40

Operations 5

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

POST /scanners/null/agents/exclusions Create an agent exclusion window · Create agent exclusion #
Ask an LLM
“How do I stop agents from scanning during a maintenance window?”
“Can an agent exclusion repeat on a schedule?”
Tell an agent
Create an agent exclusion {name} with schedule {schedule}.
Add agent blackout {name} ({description}) on schedule {schedule}.
GET /scanners/null/agents/exclusions List agent exclusions · List agent exclusions #
Ask an LLM
“Which blackout windows are set to stop agents from scanning?”
“What agent exclusions are currently in place?”
Tell an agent
List all agent exclusions.
Show me the current agent blackout windows.
GET /scanners/null/agents/exclusions/{exclusion_id} Get an agent exclusion's details · Get agent exclusion details #
Ask an LLM
“What schedule does a specific agent exclusion follow?”
“Can I look up one agent exclusion by ID?”
Tell an agent
Show agent exclusion {exclusion_id}.
Get the schedule of agent exclusion {exclusion_id}.
PUT /scanners/null/agents/exclusions/{exclusion_id} Update an agent exclusion · Update agent exclusion #
Ask an LLM
“How do I change the timing of an existing agent blackout window?”
“Can I rename an agent exclusion?”
Tell an agent
Change the schedule of agent exclusion {exclusion_id} to {schedule}.
Rename agent exclusion {exclusion_id} to {name} keeping schedule {schedule}.
DELETE /scanners/null/agents/exclusions/{exclusion_id} Delete an agent exclusion · Delete agent exclusion #
Ask an LLM
“How do I delete an agent blackout window?”
“Can I remove an agent exclusion so agents scan again?”
Tell an agent destructive · confirm first
Delete agent exclusion {exclusion_id}.
Remove the agent blackout {exclusion_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/tenable:tenable-agent-exclusions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

tenable-agent-exclusions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Tenable Platform & Settings Agent Exclusions API
  version: 1.0.0
servers:
- url: https://cloud.tenable.com
tags:
- name: Agent Exclusions
  x-displayName: Agent Exclusions
paths:
  /scanners/null/agents/exclusions:
    post:
      summary: Create agent exclusion
      description: 'Creates a new agent exclusion.

        Requires the Scan Manager [40] user role. See Roles.'
      operationId: agent-exclusions-create
      tags:
      - Agent Exclusions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the exclusion.
                description:
                  type: string
                  description: The description of the exclusion.
                schedule:
                  $ref: '#/components/schemas/agent-exclusions_schedule'
              required:
              - name
              - schedule
      responses:
        '200':
          description: Returned if the exclusion was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_exclusion'
              examples:
                response:
                  value:
                    description: Router scan exclusion
                    name: Routers
                    uuid: 152de080-fb23-4351-8ab0-6a1fb8624039
                    creation_date: 1543541807
                    last_modification_date: 1543541807
                    id: 124234
                    core_updates_blocked: true
                    schedule:
                      starttime: '2018-12-31 19:35:00'
                      endtime: '2019-12-31 19:35:00'
                      enabled: true
                      rrules:
                        freq: DAILY
                        interval: 2
                      timezone: US/Pacific
        '400':
          description: Returned if an argument is missing or invalid.
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '403':
          description: Returned if you do not have permission to create an exclusion.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - agent-exclusions_cloud: []
    get:
      summary: List agent exclusions
      description: 'Returns the list of current agent exclusions.

        Requires the Scan Manager [40] user role. See Roles.'
      operationId: agent-exclusions-list
      tags:
      - Agent Exclusions
      responses:
        '200':
          description: Returned if the list of exclusions was retrieved successfully.
          content:
            application/json:
              schema:
                description: An object containing an array of exclusion objects.
                properties:
                  exclusions:
                    $ref: '#/components/schemas/agent-exclusions_exclusions'
              examples:
                response:
                  value:
                    exclusions:
                    - description: Router scan exclusion
                      name: Routers
                      uuid: 152de080-fb23-4351-8ab0-6a1fb8624039
                      creation_date: 1543541807
                      last_modification_date: 1543541807
                      id: 124234
                      core_updates_blocked: true
                      schedule:
                        starttime: '2018-12-31 19:35:00'
                        endtime: '2019-12-31 19:35:00'
                        enabled: true
                        rrules:
                          freq: DAILY
                          interval: 8
                          byweekday: SU,MO
                          bymonthday: 9
                        timezone: US/Pacific
                    - description: Workstation scan exclusion
                      name: Workstation
                      uuid: 128de090-fb21-4451-8ab0-6b1fb8624123
                      creation_date: 2543541809
                      last_modification_date: 2543541809
                      id: 222456
                      core_updates_blocked: true
                      schedule:
                        starttime: '2018-12-31 19:35:00'
                        endtime: '2019-12-31 19:35:00'
                        enabled: true
                        rrules:
                          freq: DAILY
                          interval: 8
                          byweekday: TU
                          bymonthday: 11
                        timezone: US/Central
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '403':
          description: Returned if you do not have permission to view the exclusions.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - agent-exclusions_cloud: []
  /scanners/null/agents/exclusions/{exclusion_id}:
    get:
      summary: Get agent exclusion details
      description: 'Returns details for the specified agent exclusion.

        Requires the Scan Manager [40] user role. See Roles.'
      operationId: agent-exclusions-details
      tags:
      - Agent Exclusions
      parameters:
      - description: The ID of the exclusion.
        required: true
        name: exclusion_id
        in: path
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returned if the specified exclusion's details were retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_exclusion'
              examples:
                response:
                  value:
                    description: Router scan exclusion
                    name: Routers
                    uuid: 152de080-fb23-4351-8ab0-6a1fb8624039
                    creation_date: 1543541807
                    last_modification_date: 1543541807
                    id: 124234
                    core_updates_blocked: true
                    schedule:
                      starttime: '2018-12-31 19:35:00'
                      endtime: '2019-12-31 19:35:00'
                      enabled: true
                      rrules:
                        freq: DAILY
                        interval: 2
                      timezone: US/Pacific
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '403':
          description: Returned if you do not have permission to view the exclusion.
        '404':
          description: Returned if Tenable Vulnerability Management cannot find the specified exclusion.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - agent-exclusions_cloud: []
    put:
      summary: Update agent exclusion
      description: 'Updates an agent exclusion.

        Requires the Scan Manager [40] user role. See Roles.'
      operationId: agent-exclusions-edit
      tags:
      - Agent Exclusions
      parameters:
      - description: The ID of the exclusion to edit.
        required: true
        name: exclusion_id
        in: path
        schema:
          type: integer
          format: int32
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the exclusion.
                description:
                  type: string
                  description: The description of the exclusion.
                schedule:
                  $ref: '#/components/schemas/agent-exclusions_schedule'
              required:
              - schedule
      responses:
        '200':
          description: Returned if the exclusion was modified successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_exclusion'
              examples:
                response:
                  value:
                    description: Router scan exclusion
                    name: Routers
                    uuid: 152de080-fb23-4351-8ab0-6a1fb8624039
                    creation_date: 1543541807
                    last_modification_date: 1543541807
                    id: 124234
                    core_updates_blocked: true
                    schedule:
                      starttime: '2018-12-31 19:35:00'
                      endtime: '2019-12-31 19:35:00'
                      enabled: true
                      rrules:
                        freq: DAILY
                        interval: 2
                      timezone: US/Pacific
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '403':
          description: Returned if you do not have permission to modify the exclusion.
        '404':
          description: Returned if Tenable Vulnerability Management cannot find the specified exclusion.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - agent-exclusions_cloud: []
    delete:
      summary: Delete agent exclusion
      description: 'Deletes an agent exclusion.

        Requires the Scan Manager [40] user role. See Roles.'
      operationId: agent-exclusions-delete
      tags:
      - Agent Exclusions
      parameters:
      - description: The ID of the exclusion to delete.
        required: true
        name: exclusion_id
        in: path
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returned if the exclusion was deleted successfully.
          content:
            application/json:
              schema: {}
              examples:
                response:
                  value: {}
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '403':
          description: Returned if you do not have permission to delete the exclusion.
        '404':
          description: Returned if Tenable Vulnerability Management cannot find the specified exclusion.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent-exclusions_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - agent-exclusions_cloud: []
components:
  schemas:
    agent-exclusions_rrules:
      type: object
      required:
      - freq
      properties:
        freq:
          type: string
          description: The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).
          enum:
          - ONETIME
          - DAILY
          - WEEKLY
          - MONTHLY
          - YEARLY
        interval:
          type: integer
          description: The interval of the rule.
        byweekday:
          type: string
          description: A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA).
        bymonthday:
          type: integer
          description: The day of the month to repeat a MONTHLY freq rule on.
    agent-exclusions_ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: The HTTP status code of the error.
        error:
          type: string
          description: The standard HTTP error name.
        message:
          type: string
          description: A brief message about the cause of the error.
    agent-exclusions_schedule:
      type: object
      required:
      - starttime
      - endtime
      - rrules
      - timezone
      properties:
        enabled:
          type: boolean
          description: If true, the exclusion is scheduled.
        starttime:
          type: string
          description: The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`.
        endtime:
          type: string
          description: The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`.
        rrules:
          $ref: '#/components/schemas/agent-exclusions_rrules'
        timezone:
          type: string
          description: 'The timezone for the exclusion as returned by [scans: timezones](ref:scans-timezones).'
    agent-exclusions_exclusion:
      type: object
      properties:
        description:
          type: string
          description: The description of the exclusion.
        name:
          type: string
          description: The name of the exclusion.
        uuid:
          type: string
          description: The unique UUID of the exclusion.
        creation_date:
          type: integer
          format: int64
          description: A Unix timestamp indicating the creation date of the exclusion.
        last_modification_date:
          type: integer
          format: int64
          description: A Unix timestamp indicating the last modification date for the exclusion.
        id:
          type: integer
          description: The unique ID of the exclusion.
        core_updates_blocked:
          type: boolean
          description: Indicates whether core updates are blocked while the exclusion is active.
        schedule:
          $ref: '#/components/schemas/agent-exclusions_schedule'
    agent-exclusions_exclusions:
      type: array
      items:
        $ref: '#/components/schemas/agent-exclusions_exclusion'
  securitySchemes:
    Access_Control_API_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Access_Control_Groups_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Access_Control_Permissions_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Access_Control_Roles_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Access_Control_Users_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    access-groups_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    access-groups_v2_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    activity-log_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    agents_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Agent_Config_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    agent-exclusions_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    agent-groups_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    agent-bulk-operations_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Cloud_Connectors_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    credentials_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    exclusions_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    networks_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    OT_Connectors_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    permissions_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Profiles_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    recast-rules_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Scanners_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Scanner_Config_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Scanner_Groups_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Scanner_Profiles_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    Scanner_Tasks_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    server_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    tags_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
    target-groups_cloud:
      type: apiKey
      in: header
      name: X-ApiKeys
      description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
x-readme:
  proxy-enabled: false
  samples-languages:
  - python
  - curl
  - node
  - powershell
  - ruby
  - javascript
  - objectivec
  - java
  - php
  - csharp
  - go
  - swift
  - kotlin