📄️ apic
APIConnect toolkit 4cf706a2d55b5991dc9c6d9bd6f3b8cf63792d74 (Built 2024-04-15T2028Z)
📄️ apic clustermgmt
Clustermgmt operations
📄️ apic clustermgmt:catAliases
Retrieves the cluster’s index aliases, including filter and routing information.
📄️ apic clustermgmt:catAllocation
Snapshot of the number of shards allocated to each data node and their disk space.
📄️ apic clustermgmt:catIndices
Returns high-level information about indices in a cluster.
📄️ apic clustermgmt:catNodes
Information about a cluster’s nodes.
📄️ apic clustermgmt:catRecovery
Returns information about ongoing and completed shard recoveries.
📄️ apic clustermgmt:catShards
Detailed view of what nodes contain which shards.
📄️ apic clustermgmt:cloneIndex
Clones an existing index.
📄️ apic clustermgmt:closeIndex
Closes an index.
📄️ apic clustermgmt:createIndex
Creates a new index.
📄️ apic clustermgmt:deleteAliasByIndexAlias
Removes a data stream or index from an alias.
📄️ apic clustermgmt:deleteIndex
Deletes one or more indices.
📄️ apic clustermgmt:deleteSnapshot
Delete snapshot.
📄️ apic clustermgmt:deleteVotingConfigExclusions
Removes master-eligible nodes from the voting configuration exclusion list.
📄️ apic clustermgmt:getAlias
Retrieves information for one or more aliases.
📄️ apic clustermgmt:getAliasByIndexAlias
Retrieves information for one or more aliases.
📄️ apic clustermgmt:getAliasByName
Retrieves information for one or more aliases.
📄️ apic clustermgmt:getAllocationExplain
Result of _cluster/allocation/explain
📄️ apic clustermgmt:getFlush
Flushes one or more data streams or indices.
📄️ apic clustermgmt:getFlushByIndex
Flushes one or more data streams or indices.
📄️ apic clustermgmt:getHealth
Returns the health status of a cluster.
📄️ apic clustermgmt:getIndex
Returns indices information.
📄️ apic clustermgmt:getNodes
Returns cluster nodes information.
📄️ apic clustermgmt:getNodesByIdOrMetric
Returns cluster nodes information.
📄 ️ apic clustermgmt:getNodesHotThreads
Returns the hot threads on each selected node in the cluster.
📄️ apic clustermgmt:getNodesHotThreadsById
Returns the hot threads on each selected node in the cluster.
📄️ apic clustermgmt:getNodesMetricById
Returns cluster nodes information.
📄️ apic clustermgmt:getNodesStats
Returns cluster nodes statistics.
📄️ apic clustermgmt:getNodesStatsById
Returns cluster nodes statistics.
📄️ apic clustermgmt:getNodesStatsByIdMetric
Returns cluster nodes statistics.
📄️ apic clustermgmt:getNodesStatsByIdMetricIndex
Result of _nodes/:nodeId
📄️ apic clustermgmt:getNodesUsage
Returns information on the usage of features.
📄️ apic clustermgmt:getNodesUsageById
Returns information on the usage of features.
📄️ apic clustermgmt:getNodesUsageByIdMetric
Returns information on the usage of features.
📄️ apic clustermgmt:getPendingTasks
Returns cluster-level changes that have not yet been executed.
📄️ apic clustermgmt:getRecovery
Use the index recovery API to get information about ongoing and completed shard recoveries.
📄️ apic clustermgmt:getRecoveryByIndex
Use the index recovery API to get information about ongoing and completed shard recoveries.
📄️ apic clustermgmt:getRemoteInfo
Returns configured remote cluster information.
📄️ apic clustermgmt:getSettings
Returns cluster-wide settings.
📄️ apic clustermgmt:getSnapshot
Get snapshot.
📄️ apic clustermgmt:getState
Returns an internal representation of the cluster state for debugging or diagnostic purposes.
📄️ apic clustermgmt:getStateByMetrics
Returns an internal representation of the cluster state for debugging or diagnostic purposes.
📄️ apic clustermgmt:getStateByMetricsTarget
Returns an internal representation of the cluster state for debugging or diagnostic purposes.
📄️ apic clustermgmt:getStats
Returns cluster statistics.
📄️ apic clustermgmt:getStatsByNodeFilter
Returns cluster statistics.
📄️ apic clustermgmt:getStatsMetric
Returns cluster nodes statistics.
📄️ apic clustermgmt:getStorageSettings
Get opensearch settings.
📄️ apic clustermgmt:getUsageMetric
Returns information on the usage of features.
📄️ apic clustermgmt:openIndex
Opens a closed index. For data streams, the API opens any closed backing indices.
📄️ apic clustermgmt:postAliasByIndexAlias
Adds a data stream or index to an alias.
📄️ apic clustermgmt:postAliases
Performs one or more alias actions in a single atomic operation.
📄️ apic clustermgmt:postFlush
Flushes one or more data streams or indices.
📄️ apic clustermgmt:postFlushByIndex
Flushes one or more data streams or indices.
📄️ apic clustermgmt:postReloadSecureSettings
Reloads the keystore on nodes in the cluster.
📄️ apic clustermgmt:postReloadSecureSettingsById
Reloads the keystore on nodes in the cluster.
📄️ apic clustermgmt:postReroute
Changes the allocation of shards in a cluster.
📄️ apic clustermgmt:postVotingConfigExclusions
Adds master-eligible nodes from the voting configuration exclusion list.
📄️ apic clustermgmt:putAliasByIndexAlias
Adds a data stream or index to an alias.
📄️ apic clustermgmt:putSettings
Configures dynamic cluster settings.
📄️ apic clustermgmt:putStorageSettings
Put opensearch settings.
📄️ apic clustermgmt:repositories
Get snapshot repositories.
📄️ apic clustermgmt:repository
Get snapshot repository.
📄️ apic clustermgmt:resolveIndex
Resolve name and index patterns for indices, aliases and data streams
📄️ apic clustermgmt:rolloverIndex
Creates a new index for a data stream or index alias.
📄️ apic clustermgmt:rolloverToTarget
Creates a new index for a data stream or index alias.
📄️ apic clustermgmt:shrinkIndex
Shrinks an existing index into a new index with fewer primary shards.
📄️ apic clustermgmt:snapshotStatus
Get snapshot status.
📄️ apic clustermgmt:snapshotStatusByRepository
Get snapshot status by repository.
📄️ apic clustermgmt:snapshotStatusByRepositorySnapshot
Get snapshot status by repository and snapshot.
📄️ apic clustermgmt:snapshotVerify
Verify snapshot repository.
📄️ apic clustermgmt:splitIndex
Splits an existing index into a new index with more primary shards.
📄️ apic config
Manage configuration variables
📄️ apic config:clear
Delete all configuration variables
📄️ apic config:delete
Delete a configuration variable
📄️ apic config:get
Get a configuration variable
📄️ apic config:list
List the application and global configuration variables
📄 ️ apic config:set
Set or update configuration variables
📄️ apic dashboards
Dashboards operations
📄️ apic dashboards:catalogApi
Get the data needed to populate the API dashboard at catalog scope.
📄️ apic dashboards:catalogConsumption
Get the data needed to populate the Consumption dashboard at catalog scope.
📄️ apic dashboards:catalogData
Get the data needed to populate the Data dashboard at catalog scope.
📄️ apic dashboards:catalogGateway
Get the data needed to populate the Gateway Operations dashboard at catalog scope.
📄️ apic dashboards:catalogLatency
Get the data needed to populate the Latency dashboard at catalog scope.
📄️ apic dashboards:catalogProduct
Get the data needed to populate the Product dashboard at catalog scope.
📄️ apic dashboards:catalogStatus
Get the data needed to populate the Status dashboard at catalog scope.
📄️ apic dashboards:catalogUsage
Get the data needed to populate the Usage dashboard at catalog scope.
📄️ apic dashboards:cloudApi
Get the data needed to populate the API dashboard at cloud scope.
📄️ apic dashboards:cloudConsumption
Get the data needed to populate the Consumption dashboard at cloud scope.
📄️ apic dashboards:cloudData
Get the data needed to populate the Data dashboard at cloud scope.
📄️ apic dashboards:cloudGateway
Get the data needed to populate the Gateway Operations dashboard at cloud scope.
📄️ apic dashboards:cloudLatency
Get the data needed to populate the Latency dashboard at cloud scope.
📄️ apic dashboards:cloudProduct
Get the data needed to populate the Product dashboard at cloud scope.
📄️ apic dashboards:cloudStatus
Get the data needed to populate the Status dashboard at cloud scope.
📄️ apic dashboards:cloudUsage
Get the data needed to populate the Usage dashboard at cloud scope.
📄️ apic dashboards:orgApi
Get the data needed to populate the API dashboard at provider organization scope.
📄️ apic dashboards:orgConsumption
Get the data needed to populate the Consumption dashboard at provider organization scope.
📄️ apic dashboards:orgData
Get the data needed to populate the Data dashboard at provider organization scope.
📄️ apic dashboards:orgGateway
Get the data needed to populate the Gateway Operations dashboard at provider organization scope.
📄️ apic dashboards:orgLatency
Get the data needed to populate the Latency dashboard at provider organization scope.
📄️ apic dashboards:orgProduct
Get the data needed to populate the Product dashboard at provider organization scope.
📄️ apic dashboards:orgStatus
Get the data needed to populate the Status dashboard at provider organization scope.
📄️ apic dashboards:orgUsage
Get the data needed to populate the Usage dashboard at provider organization scope.
📄️ apic dashboards:spaceApi
Get the data needed to populate the API dashboard at space scope.
📄️ apic dashboards:spaceConsumption
Get the data needed to populate the Consumption dashboard at space scope.
📄️ apic dashboards:spaceData
Get the data needed to populate the Data dashboard at space scope.
📄️ apic dashboards:spaceGateway
Get the data needed to populate the Gateway Operations dashboard at space scope.
📄️ apic dashboards:spaceLatency
Get the data needed to populate the Latency dashboard at space scope.
📄️ apic dashboards:spaceProduct
Get the data needed to populate the Product dashboard at space scope.
📄️ apic dashboards:spaceStatus
Get the data needed to populate the Status dashboard at space scope.
📄️ apic dashboards:spaceUsage
Get the data needed to populate the Usage dashboard at space scope.
📄️ apic events
Events operations
📄️ apic events:catalogCount
Count events at catalog scope.
📄️ apic events:catalogGet
Get specific event at catalog scope.
📄️ apic events:catalogList
List events at catalog scope.
📄️ apic events:cloudCount
Count events at cloud scope.
📄️ apic events:cloudGet
Get specific event at cloud scope.
📄️ apic events:cloudList
List events at cloud scope.
📄️ apic events:cloudScroll
Scroll through results in batches.
📄️ apic events:cloudScrollDelete
Clears the scroll search context.
📄️ apic events:orgCount
Count events at provider organization scope.
📄️ apic events:orgGet
Get specific event at provider organization scope.
📄️ apic events:orgList
List events at provider organization scope.
📄️ apic events:orgScroll
Scroll through results in batches.
📄️ apic events:orgScrollDelete
Clears the scroll search context.
📄️ apic events:spaceCount
Count events at space scope.
📄️ apic events:spaceGet
Get specific event at space scope.
📄️ apic events:spaceList
List events at space scope.
📄️ apic filterparams
Filterparams operations
📄️ apic filterparams:catalogList
List of filter parameters supported at catalog scope.
📄️ apic filterparams:cloudList
List of filter parameters supported at cloud scope.
📄️ apic filterparams:orgList
List of filter parameters supported at provider organization scope.
📄️ apic filterparams:spaceList
List of filter parameters supported at space scope.
📄️ apic licenses
Review the license for API Connect
📄️ apic queries
Queries operations
📄️ apic queries:catalogClone
Make a personal copy of a shared query.
📄️ apic queries:catalogCreate
Create a query at catalog scope.
📄️ apic queries:catalogDelete
Deletes the specified query at catalog scope.
📄️ apic queries:catalogGet
Get a specific query at catalog scope.
📄️ apic queries:catalogList
List saved queries at catalog scope.
📄️ apic queries:catalogListShared
List shared queries at catalog scope.
📄️ apic queries:catalogShare
Share a saved query.
📄️ apic queries:catalogTransferOwner
Transfer ownership of a saved query to a different user.
📄️ apic queries:catalogUnshare
Unshare a saved query.
📄️ apic queries:catalogUpdate
Update a specific query at catalog scope.
📄️ apic queries:cloudClone
Make a personal copy of a shared query.
📄️ apic queries:cloudCreate
Create a query at cloud scope.
📄️ apic queries:cloudDelete
Deletes the specified query at cloud scope.
📄️ apic queries:cloudGet
Get a specific query at cloud scope.
📄️ apic queries:cloudList
List saved queries at cloud scope.
📄️ apic queries:cloudListShared
List shared queries at cloud scope.
📄️ apic queries:cloudShare
Share a saved query.
📄️ apic queries:cloudTransferOwner
Transfer ownership of a saved query to a different user.
📄️ apic queries:cloudUnshare
Unshare a saved query.
📄️ apic queries:cloudUpdate
Update a specific query at cloud scope.
📄️ apic queries:orgClone
Make a personal copy of a shared query.
📄️ apic queries:orgCreate
Create a query at org scope.
📄️ apic queries:orgDelete
Deletes the specified query at org scope.
📄️ apic queries:orgGet
Get a specific query at org scope.
📄️ apic queries:orgList
List saved queries at org scope.
📄️ apic queries:orgListShared
List shared queries at org scope.
📄️ apic queries:orgShare
Share a saved query.
📄️ apic queries:orgTransferOwner
Transfer ownership of a saved query to a different user.
📄️ apic queries:orgUnshare
Unshare a saved query.
📄️ apic queries:orgUpdate
Update a specific query at org scope.
📄️ apic queries:spaceClone
Make a personal copy of a shared query.
📄️ apic queries:spaceCreate
Create a query at space scope.
📄️ apic queries:spaceDelete
Deletes the specified query at space scope.
📄️ apic queries:spaceGet
Get a specific query at space scope.
📄️ apic queries:spaceList
List saved queries at space scope.
📄️ apic queries:spaceListShared
List shared queries at space scope.
📄️ apic queries:spaceShare
Share a saved query.
📄️ apic queries:spaceTransferOwner
Transfer ownership of a saved query to a different user.
📄️ apic queries:spaceUnshare
Unshare a saved query.
📄️ apic queries:spaceUpdate
Update a specific query at space scope.
📄️ apic service
Service operations
📄️ apic service:catalogServicestatus
Used by the UI to get the analytics service status.
📄️ apic service:cloudServicestatus
Used by the UI to get the analytics service status.
📄️ apic service:orgServicestatus
Used by the UI to get the analytics service status.
📄️ apic service:spaceServicestatus
Used by the UI to get the analytics service status.
📄️ apic validate
Validate an API or product definition
📄️ apic version
Get the APIConnect toolkit version