Cisco Intersight

Cisco Intersight Ssh API

The ssh API from Cisco Intersight — 4 operation(s) for ssh.

Documentation GitHub OpenAPI

Operations 8

POST /api/v1/ssh/Policies Create a 'ssh.Policy' resource. #

GET /api/v1/ssh/Policies Read a 'ssh.Policy' resource. #

GET /api/v1/ssh/Policies/{Moid} Read a 'ssh.Policy' resource. #

POST /api/v1/ssh/Policies/{Moid} Update a 'ssh.Policy' resource. #

PATCH /api/v1/ssh/Policies/{Moid} Update a 'ssh.Policy' resource. #

DELETE /api/v1/ssh/Policies/{Moid} Delete a 'ssh.Policy' resource. #

GET /api/v1/ssh/PolicyInventories Read a 'ssh.PolicyInventory' resource. #

GET /api/v1/ssh/PolicyInventories/{Moid} Read a 'ssh.PolicyInventory' resource. #

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/intersight-ssh-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and

    3rd party IT infrastructure. This platform offers an intelligent level of management that enables

    IT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior

    generations of tools. Cisco Intersight provides an integrated and intuitive management experience for

    resources in the traditional data center as well as at the edge. With flexible deployment options to address

    complex security needs, getting started with Intersight is quick and easy.

    Cisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment,

    configuration, and ongoing maintenance. The model-based deployment works for a single system in a remote

    location or hundreds of systems in a data center and enables rapid, standardized configuration and deployment.

    It also streamlines maintaining those systems whether you are working with small or very large configurations.

    The Intersight OpenAPI document defines the complete set of properties that are returned in the

    HTTP response. From that perspective, a client can expect that no additional properties are returned,

    unless these properties are explicitly defined in the OpenAPI document.

    However, when a client uses an older version of the Intersight OpenAPI document, the server may

    send additional properties because the software is more recent than the client. In that case, the client

    may receive properties that it does not know about.

    Some generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document.

    This document was created on 2026-08-07T06:46:04Z.'
  version: 1.0.11-20260807064027971
  title: Cisco Intersight Server Ssh API
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    name: Intersight API support
    url: https://intersight.com/help
    email: intersight@cisco.com
  x-provenance:
    method: harvested
    authored_by: Cisco Intersight
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: cdn.intersight.com
    note: Cisco publishes the full Intersight OpenAPI 3.0.2 anonymously from its CDN (27.5MB master document; 3,963 operations / 2,448 paths / 5,612 schemas) plus 11 per-service documents covering 100% of the master's paths. Byte-identity reconfirmed 2026-08-19 by SHA-256. Note intersight.com itself is a soft-404 farm — the contract is on the CDN, not the app host.
  x-evidence:
  - type: source
    url: https://cdn.intersight.com/components/an-apidocs/1.0.11-20260807064027971/model/intersight-openapi-v3-1.0.11-20260807064027971.json
  - type: source
    url: https://intersight.com/apidocs/apirefs/
servers:
- url: https://{server}
  variables:
    server:
      default: intersight.com
  description: The Intersight URL for the cloud-based infrastructure management APIs.
tags:
- name: ssh
paths:
  /api/v1/ssh/Policies:
    post:
      tags:
      - ssh
      summary: Create a 'ssh.Policy' resource.
      operationId: CreateSshPolicy
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - CREATE.ssh.Policy
        - PRIVSET.Account Administrator
        - PRIVSET.Create, clone and edit SSH policies
        - PRIVSET.Manage Server Profiles
        - ROLE.Account Administrator
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      - $ref: '#/components/parameters/IfNoneMatch'
      requestBody:
        description: The 'ssh.Policy' resource to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh.Policy'
      responses:
        '200':
          description: The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was created as requested. The 'ssh.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.Policy'
          links:
            GetSshPolicyByMoid:
              operationId: GetSshPolicyByMoid
              parameters:
                Moid: $response.body#/Moid
              description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'.
            GetIamAccountByMoid:
              $ref: '#/components/links/GetIamAccountByMoid'
            GetIamDomainGroupByMoid:
              $ref: '#/components/links/GetIamDomainGroupByMoid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
    get:
      tags:
      - ssh
      summary: Read a 'ssh.Policy' resource.
      operationId: GetSshPolicyList
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Manage Server Profiles
        - PRIVSET.Read-Only
        - PRIVSET.Read-only SSH policies
        - PRIVSET.View Server Profiles
        - READ.ssh.Policy
        - ROLE.Account Administrator
        - ROLE.Read-Only
      parameters:
      - $ref: '#/components/parameters/filterParam'
      - $ref: '#/components/parameters/orderbyParam'
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/selectParam'
      - $ref: '#/components/parameters/expandParam'
      - $ref: '#/components/parameters/applyParam'
      - $ref: '#/components/parameters/countParam'
      - $ref: '#/components/parameters/inlinecountParam'
      - $ref: '#/components/parameters/atParam'
      - $ref: '#/components/parameters/tagsParam'
      responses:
        '200':
          description: List of 'ssh.Policy' resources for the given filter criteria
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
            Content-Disposition:
              $ref: '#/components/headers/Content-Disposition'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.Policy.Response'
            text/csv:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
  /api/v1/ssh/Policies/{Moid}:
    get:
      tags:
      - ssh
      summary: Read a 'ssh.Policy' resource.
      operationId: GetSshPolicyByMoid
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Manage Server Profiles
        - PRIVSET.Read-Only
        - PRIVSET.Read-only SSH policies
        - PRIVSET.View Server Profiles
        - READ.ssh.Policy
        - ROLE.Account Administrator
        - ROLE.Read-Only
      parameters:
      - $ref: '#/components/parameters/moidParam'
      - $ref: '#/components/parameters/selectParam'
      - $ref: '#/components/parameters/expandParam'
      - $ref: '#/components/parameters/atParam'
      responses:
        '200':
          description: An instance of the 'ssh.Policy' resource.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
            Content-Disposition:
              $ref: '#/components/headers/Content-Disposition'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.Policy'
            text/csv:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile
          links:
            GetSshPolicyByMoid:
              operationId: GetSshPolicyByMoid
              parameters:
                Moid: $response.body#/Moid
              description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'.
            GetIamAccountByMoid:
              $ref: '#/components/links/GetIamAccountByMoid'
            GetIamDomainGroupByMoid:
              $ref: '#/components/links/GetIamDomainGroupByMoid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
    post:
      tags:
      - ssh
      summary: Update a 'ssh.Policy' resource.
      operationId: UpdateSshPolicy
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Edit SSH policies
        - PRIVSET.Manage Server Profiles
        - ROLE.Account Administrator
        - UPDATE.ssh.Policy
      parameters:
      - $ref: '#/components/parameters/moidParam'
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        description: The 'ssh.Policy' resource to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh.Policy'
          application/json-patch+json:
            schema:
              $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument
      responses:
        '200':
          description: The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was modified as requested. The 'ssh.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.Policy'
          links:
            GetSshPolicyByMoid:
              operationId: GetSshPolicyByMoid
              parameters:
                Moid: $response.body#/Moid
              description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'.
            GetIamAccountByMoid:
              $ref: '#/components/links/GetIamAccountByMoid'
            GetIamDomainGroupByMoid:
              $ref: '#/components/links/GetIamDomainGroupByMoid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
    patch:
      tags:
      - ssh
      summary: Update a 'ssh.Policy' resource.
      operationId: PatchSshPolicy
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Edit SSH policies
        - PRIVSET.Manage Server Profiles
        - ROLE.Account Administrator
        - UPDATE.ssh.Policy
      parameters:
      - $ref: '#/components/parameters/moidParam'
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        description: The 'ssh.Policy' resource to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh.Policy'
          application/json-patch+json:
            schema:
              $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument
      responses:
        '200':
          description: The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was patched as requested. The 'ssh.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.Policy'
          links:
            GetSshPolicyByMoid:
              operationId: GetSshPolicyByMoid
              parameters:
                Moid: $response.body#/Moid
              description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'.
            GetIamAccountByMoid:
              $ref: '#/components/links/GetIamAccountByMoid'
            GetIamDomainGroupByMoid:
              $ref: '#/components/links/GetIamDomainGroupByMoid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
    delete:
      tags:
      - ssh
      summary: Delete a 'ssh.Policy' resource.
      operationId: DeleteSshPolicy
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - DELETE.ssh.Policy
        - PRIVSET.Account Administrator
        - PRIVSET.Delete SSH policies
        - PRIVSET.Manage Server Profiles
        - ROLE.Account Administrator
      parameters:
      - $ref: '#/components/parameters/moidParam'
      responses:
        '200':
          description: Resource has been deleted successfully.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
  /api/v1/ssh/PolicyInventories:
    get:
      tags:
      - ssh
      summary: Read a 'ssh.PolicyInventory' resource.
      operationId: GetSshPolicyInventoryList
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Manage Server Profiles
        - PRIVSET.Read-Only
        - PRIVSET.Read-only SSH policies
        - PRIVSET.View Server Profiles
        - READ.ssh.PolicyInventory
        - ROLE.Account Administrator
        - ROLE.Read-Only
      parameters:
      - $ref: '#/components/parameters/filterParam'
      - $ref: '#/components/parameters/orderbyParam'
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/selectParam'
      - $ref: '#/components/parameters/expandParam'
      - $ref: '#/components/parameters/applyParam'
      - $ref: '#/components/parameters/countParam'
      - $ref: '#/components/parameters/inlinecountParam'
      - $ref: '#/components/parameters/atParam'
      - $ref: '#/components/parameters/tagsParam'
      responses:
        '200':
          description: List of 'ssh.PolicyInventory' resources for the given filter criteria
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
            Content-Disposition:
              $ref: '#/components/headers/Content-Disposition'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.PolicyInventory.Response'
            text/csv:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
  /api/v1/ssh/PolicyInventories/{Moid}:
    get:
      tags:
      - ssh
      summary: Read a 'ssh.PolicyInventory' resource.
      operationId: GetSshPolicyInventoryByMoid
      security:
      - cookieAuth: []
      - http_signature: []
      - oAuth2:
        - PRIVSET.Account Administrator
        - PRIVSET.Manage Server Profiles
        - PRIVSET.Read-Only
        - PRIVSET.Read-only SSH policies
        - PRIVSET.View Server Profiles
        - READ.ssh.PolicyInventory
        - ROLE.Account Administrator
        - ROLE.Read-Only
      parameters:
      - $ref: '#/components/parameters/moidParam'
      - $ref: '#/components/parameters/selectParam'
      - $ref: '#/components/parameters/expandParam'
      - $ref: '#/components/parameters/atParam'
      responses:
        '200':
          description: An instance of the 'ssh.PolicyInventory' resource.
          headers:
            Set-Cookie:
              $ref: '#/components/headers/Set-Cookie'
            x-starship-traceid:
              $ref: '#/components/headers/x-starship-traceid'
            Content-Disposition:
              $ref: '#/components/headers/Content-Disposition'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh.PolicyInventory'
            text/csv:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile
          links:
            GetSshPolicyInventoryByMoid:
              operationId: GetSshPolicyInventoryByMoid
              parameters:
                Moid: $response.body#/Moid
              description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/PolicyInventories/{Moid}'.
            GetIamAccountByMoid:
              $ref: '#/components/links/GetIamAccountByMoid'
            GetIamDomainGroupByMoid:
              $ref: '#/components/links/GetIamDomainGroupByMoid'
        '400':
          $ref: '#/components/responses/http_status_400'
        '401':
          $ref: '#/components/responses/http_status_401'
        '403':
          $ref: '#/components/responses/http_status_403'
        '404':
          $ref: '#/components/responses/http_status_404'
        default:
          $ref: '#/components/responses/default'
components:
  parameters:
    IfMatch:
      name: If-Match
      in: header
      description: 'For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent

        the lost update problem. It can check if the modification of a resource that the user wants to upload

        will not override another change that has been done since the original resource was fetched.

        If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned.

        When modifying a resource using POST or PUT, the If-Match header must be set to the value of

        the resource ModTime property after which no lost update problem should occur.

        For example, a client send a GET request to obtain a resource, which includes the ModTime property.

        The ModTime indicates the last time the resource was created or modified. The client then sends

        a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained

        in the GET request.'
      required: false
      schema:
        type: string
    IfNoneMatch:
      name: If-None-Match
      in: header
      description: 'For methods that apply server-side changes, If-None-Match used with the * value can be used to create

        a resource not known to exist, guaranteeing that another resource creation didn''t happen before,

        losing the data of the previous put. The request will be processed only if the eventually existing

        resource''s ETag doesn''t match any of the values listed. Otherwise, the status code 412

        (Precondition Failed) is used.

        The asterisk is a special value representing any resource. It is only useful when creating a resource,

        usually with PUT, to check if another resource with the identity has already been created before.

        The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are

        considered identical if the content is equivalent - they don''t have to be identical byte for byte.'
      required: false
      schema:
        type: string
    moidParam:
      name: Moid
      in: path
      required: true
      description: The unique Moid identifier of a resource instance.
      schema:
        type: string
    expandParam:
      name: $expand
      in: query
      description: Specify additional attributes or related resources to return in addition to the primary resources.
      required: false
      schema:
        type: string
      examples:
        expand_displaynames:
          summary: Return the resources.
          value: $expand=DisplayNames
    atParam:
      name: at
      in: query
      description: 'Similar to "$filter", but "at" is specifically used to filter versioning information properties for resources to return.

        A URI with an "at" Query Option identifies a subset of the Entries from the Collection of Entries identified by the

        Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate

        expression specified by the query option.

        The expression language that is used in at operators supports references to properties and

        literals. The literal values can be strings enclosed in single quotes, numbers and boolean values

        (true or false) or any of the additional literal representations shown in the Abstract

        Type System section.'
      examples:
        versiontype_equality:
          summary: Return the resources where the 'VersionType' property of the VersionContext is equal to 'Configured'
          value: at=VersionType eq 'Configured'
        interestedmos_query:
          summary: Return the resources where the 'InterestedMos' property of the VersionContext includes an MoRef with Moid equal to '5b5877e56c6730367acf46cd'
          value: at=InterestedMos.Moid eq '5b5877e56c6730367acf46cd'
      required: false
      schema:
        type: string
    applyParam:
      name: $apply
      in: query
      description: 'Specify one or more transformation operations to perform aggregation on the resources. The transformations

        are processed in order with the output from a transformation being used as input for the subsequent transformation.

        The "$apply" query takes a sequence of set transformations, separated by forward slashes to express that they are

        consecutively applied, i.e., the result of each transformation is the input to the next transformation.

        Supported aggregation methods are "aggregate" and "groupby".

        The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns

        a result set with a single instance, representing the aggregated value for all instances in the input set.

        The **groupby** transformation takes one or two parameters and

        1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter,

        2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality,

        3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group,

        4. Concatenates the intermediate result sets into one result set.

        A groupby transformation affects the structure of the result set.'
      required: false
      schema:
        type: string
    skipParam:
      name: $skip
      in: query
      description: Specifies the number of resources to skip in the response.
      required: false
      allowEmptyValue: false
      schema:
        type: integer
        format: int32
        default: 0
      examples:
        skip:
          summary: Return the resources. Skip the first 100 resources.
          value: $skip=100
        skip_and_top:
          summary: Return the resources. Skip the first 100 resources and return up to 20 resources.
          value: $skip=100&$top=20
        skip_with_filter:
          summary: Return the resources that were created less than two hours ago. Skip the first 100 resources and return up to 20 resources.
          value: $skip=100&$top=20&$filter=CreateTime gt now() sub PT2H
    inlinecountParam:
      name: $inlinecount
      in: query
      description: The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
      required: false
      allowEmptyValue: false
      schema:
        type: string
        enum:
        - allpages
        - none
        default: allpages
      examples:
        inlinecount_output:
          summary: Return the count of the resources, and an array containing the resources.
          value: $inlinecount=true
        inlinecount_filtered:
          summary: Return the count of the resources that were created less than two hours ago, and an array containing the resources.
          value: $inlinecount=true&$filter=CreateTime gt now() sub PT2H
    tagsParam:
      name: tags
      in: query
      description: The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
      required: false
      schema:
        type: string
    selectParam:
      name: $select
      in: query
      description: Specifies a subset of properties to return.
      required: false
      schema:
        type: string
        default: ''
      examples:
        select:
          summary: Return a summary list of resources. The response will include the Moid, which is always returned, and the 'CreateTime' and 'ModTime' properties.
          value: $select=CreateTime,ModTime
        select_filtered:
          summary: Return a filtered, summary list of resources.
          value: $select=CreateTime,ModTime&$filter=CreateTime gt now() sub PT2H
          description: 'Return a summary list of resources. The response will include the Moid, which is always returned even if it is not specified in the $select query,

            and the ''CreateTime'' and ''ModTime'' properties, which are explicitly specified in the $select query.

            The results are filtered and only include the resources that were created less than two hours ago.'
    countParam:
      name: $count
      in: query
      description: The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
      required: false
      allowEmptyValue: false
      schema:
        type: boolean
      examples:
        total_count:
          summary: Return the count of the resources.
          value: $count=true
        count_filtered:
          summary: Return the count of resources that were created less than two hours ago.
          value: $count=true&$filter=CreateTime gt now() sub PT2H
    filterParam:
      name: $filter
      in: query
      description: 'Filter criteria for the resources to return.

        A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting

        only the Entries that satisfy the predicate expression specified by the $filter option.

        The expression language that is used in $filter queries supports references to properties and

        literals. The literal values can be strings enclosed in single quotes, numbers and boolean values

        (true or false).'
      required: false
      schema:
        type: string
        default: ''
      examples:
        property_createTime_gt:
          summary: Return the resources where the 'CreateTime' property is greater than the specified date.
          value: $filter=CreateTime gt 2012-08-29T21:58:33Z
        property_createTime_gt_now:
          summary: Return the resources that were created less than seventy-two hours ago.
          value: $filter=CreateTime gt now() sub PT72H
          description: 'This example uses a filter expression to compare the ''CreateTime'' property of the resource against the current time.

            The now() function is resolved to the current time in the Intersight service when the query is processed.

            ''PT72H'' is a string value that represents 72 hours.

            See https://intersight.com/apidocs for more details about how to construct a duration.

            The "sub" operator is used to substract a duration from the current time.'
        property_createTime_lt_now:
          summary: Return the resources that were created at least 60 days ago.
          value: $filter=CreateTime lt now() sub P60D
        property_modTime_gt_now1:
          summary: Return the resources that were modified less than three minutes and 20 seconds ago.
          value: $filter=ModTime gt now() sub PT3M20S
        property_modTime_gt_now2:
          summary: Return the resources that were modified less than 90 days ago.
          value: $filter=ModTime gt now() sub P90D
        property_modTime_gt_now3:
          summary: Return the resources that were modified less than 1 day and 12 hours ago.
          value: $filter=ModTime gt now() sub P1DT12H
    orderbyParam:
      name: $orderby
     

# --- truncated at 32 KB (417 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/intersight/refs/heads/main/openapi/intersight-ssh-api-openapi.yml