Every API here is available over the APIs.io API and to AI agents over MCP.
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 System Search 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: search
paths:
/api/v1/search/SuggestItems:
post:
tags:
- search
summary: Create a 'search.SuggestItem' resource.
operationId: CreateSearchSuggestItem
security:
- cookieAuth: []
- http_signature: []
- oAuth2:
- CREATE.search.SuggestItem
parameters:
- $ref: '#/components/parameters/IfMatch'
- $ref: '#/components/parameters/IfNoneMatch'
requestBody:
description: The 'search.SuggestItem' resource to create.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/search.SuggestItem'
responses:
'200':
description: List of 'search.SuggestItem' 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/search.SuggestItem.Response'
'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/search/SearchItems:
get:
tags:
- search
summary: Read a 'search.SearchItem' resource.
operationId: GetSearchSearchItemList
security:
- cookieAuth: []
- http_signature: []
- oAuth2:
- PRIVSET.Global Read Privileges
- PRIVSET.Global System Privileges
- READ.search.SearchItem
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 'search.SearchItem' 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/search.SearchItem.Response'
text/csv:
schema:
$ref: '#/components/schemas/CsvFile'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/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/search/SearchItems/{Moid}:
get:
tags:
- search
summary: Read a 'search.SearchItem' resource.
operationId: GetSearchSearchItemByMoid
security:
- cookieAuth: []
- http_signature: []
- oAuth2:
- PRIVSET.Global Read Privileges
- PRIVSET.Global System Privileges
- READ.search.SearchItem
parameters:
- $ref: '#/components/parameters/moidParam'
- $ref: '#/components/parameters/selectParam'
- $ref: '#/components/parameters/expandParam'
- $ref: '#/components/parameters/atParam'
responses:
'200':
description: An instance of the 'search.SearchItem' 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/search.SearchItem'
text/csv:
schema:
$ref: '#/components/schemas/CsvFile'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/components/schemas/ExcelFile'
links:
GetSearchSearchItemByMoid:
operationId: GetSearchSearchItemByMoid
parameters:
Moid: $response.body#/Moid
description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/search/SearchItems/{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'
/api/v1/search/TagItems:
get:
tags:
- search
summary: Read a 'search.TagItem' resource.
operationId: GetSearchTagItemList
security:
- cookieAuth: []
- http_signature: []
- oAuth2:
- PRIVSET.Global Read Privileges
- PRIVSET.Global System Privileges
- READ.search.TagItem
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 'search.TagItem' 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/search.TagItem.Response'
text/csv:
schema:
$ref: '#/components/schemas/CsvFile'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/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/search/TagItems/{Moid}:
get:
tags:
- search
summary: Read a 'search.TagItem' resource.
operationId: GetSearchTagItemByMoid
security:
- cookieAuth: []
- http_signature: []
- oAuth2:
- PRIVSET.Global Read Privileges
- PRIVSET.Global System Privileges
- READ.search.TagItem
parameters:
- $ref: '#/components/parameters/moidParam'
- $ref: '#/components/parameters/selectParam'
- $ref: '#/components/parameters/expandParam'
- $ref: '#/components/parameters/atParam'
responses:
'200':
description: An instance of the 'search.TagItem' 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/search.TagItem'
text/csv:
schema:
$ref: '#/components/schemas/CsvFile'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/components/schemas/ExcelFile'
links:
GetSearchTagItemByMoid:
operationId: GetSearchTagItemByMoid
parameters:
Moid: $response.body#/Moid
description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/search/TagItems/{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
in: query
description: Determines what properties are used to sort the collection of resources.
required: false
schema:
type: string
examples:
date_sort_ascending:
summary: Return the resources, sorted by creation time in ascending order, i.e., oldest resources first.
value: $orderby=CreationTime
date_sort_descending:
summary: Return the resources, sorted by creation time in descending order, i.e., most recently created resources first.
value: $orderby=-CreationTime
date_sort_filtered_descending:
summary: Return the resources that have been modified less than 80 minutes ago, sorted by modification time, most recently modified resources first.
value: $orderby=-ModTime&$filter=ModTime gt now() sub PT80M
sorted_results_with_paging:
summary: Return the first 20 resources sorted by modification time.
value: $top=20&$orderby=ModTime
topParam:
name: $top
in: query
description: Specifies the maximum number of resources to return in the response.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 100
examples:
top:
summary: Return up to 10 resources.
value: $top=10
top_with_filter:
summary: Return up to 20 resources that were created less than two hours ago.
value: $top=20&$filter=CreateTime gt now() sub PT2H
headers:
x-starship-traceid:
description: A value that uniquely identifies a HTTP request and its response.
schema:
type: string
Set-Cookie:
description: Cookie authentication key for use with the `cookieAuth` apiKey authentication.
schema:
type: string
example: X-Starship-Token=abcde12345; Path=/
Content-Length:
description: Indicates the size of the entity-body, in bytes, sent to the recipient.
schema:
type: integer
Content-Disposition:
description: If not present, indicates the response content is expected to be displayed inline in the browser, that is, as a Web page or as part of a Web page. If present, indicates the response content is expected to be an attachment, that is downloaded and saved locally.
schema:
type: string
responses:
http_status_404:
description: The specified resource was not found. The HTTP body contains a document that provides more details about the error.
headers:
x-starship-traceid:
$ref: '#/components/headers/x-starship-traceid'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: An unexpected error occurred.
headers:
x-starship-traceid:
$ref: '#/components/headers/x-starship-traceid'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
http_status_401:
description: 'The request requires user authentication. The client may repeat the request with a suitable Authorization header field.
If the request already included Authorization credentials, then the 401 response indicates that authorization has
been refused for those credentials.
The HTTP body may contain a document that provides more details about the error.'
headers:
x-starship-traceid:
$ref: '#/components/headers/x-starship-traceid'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
http_status_400:
description: 'The request could not be understood by the server due to malformed syntax.
The client SHOULD NOT repeat the request without modifications.
For example, the request may contain an incorrect JSON syntax, or the request fails
validation checks.
The HTTP body may contain a document that provides more details about the error.'
headers:
x-starship-traceid:
$ref: '#/components/headers/x-starship-traceid'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
http_status_403:
description: 'The request was properly authenticated, but the server is refusing to fulfill it.
The HTTP body may contain a document that provides more details about the error.
For example, the user may not have sufficient privileges to perform the request.'
headers:
x-starship-traceid:
$ref: '#/components/headers/x-starship-traceid'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
mo.Tag:
type: object
title: Mo:Tag
description: 'An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by
assigning meta-data tags to any object.'
properties:
AncestorDefinitions:
type:
- array
- 'null'
items:
description: The array containing the tag definition references of the ancestors in the object containment hierarchy.
$ref: '#/components/schemas/mo.MoRef'
readOnly: true
x-omitempty: true
Definition:
description: 'The definition is a reference to the tag definition object.
The tag definition object contains the properties of the tag such as name, type, and description.'
$ref: '#/components/schemas/mo.MoRef'
readOnly: true
x-omitempty: true
Key:
description: The string representation of a tag key.
type: string
minLength: 1
maxLength: 356
x-omitempty: true
Propagated:
description: Propagated is a boolean flag that indicates whether the tag is propagated to the related managed objects.
type: boolean
readOnly: true
x-omitempty: true
SysTag:
description: Specifies whether the tag is user-defined or owned by the system.
type: boolean
readOnly: true
x-omitempty: true
Type:
description: 'An enum type that defines the type of tag. Supported values are ''pathtag'' and ''keyvalue''.
* `KeyValue` - KeyValue type of tag. Key is required for these tags. Value is optional.
* `PathTag` - Key contain path information. Value is not present for these tags. The path is created by using the ''/'' character as a delimiter.For example, if the tag is "A/B/C", then "A" is the parent tag, "B" is the child tag of "A" and "C" is the child tag of "B".'
type: string
enum:
- KeyValue
- PathTag
default: KeyValue
readOnly: true
x-omitempty: true
Value:
description: The string representation of a tag value.
type: string
minLength: 0
maxLength: 256
x-omitempty: true
mo.AggregateTransform:
description: "The output of a request that includes the $apply query parameter.\nThe schema of an aggregation query is dynamically determined based on the request query parameters. \nSee https://intersight.com/apidocs/introduction/query/#apply-query-option for more details."
allOf:
# --- truncated at 32 KB (630 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/intersight/refs/heads/main/openapi/intersight-search-api-openapi.yml