PowerShell

PowerShell is a cross-platform task automation solution made up of a command-line shell, a scripting language, and a configuration management framework. The PowerShell ecosystem exposes APIs through the PowerShell Gallery (an OData-based package repository), the Runspace .NET hosting APIs, and PowerShell Remoting protocols (WS-Management and SSH).

3 APIs 0 Features

AutomationCommand-LineCross-PlatformScriptingShellWindowsDevOps

APIs

PowerShell Gallery API

The PowerShell Gallery is the central repository for PowerShell modules, scripts, and DSC resources. It exposes a public OData v2 API for searching, retrieving, and downloading ...

PowerShell Runspace API

.NET APIs for creating, configuring, and managing PowerShell runspaces from host applications. Enables embedding PowerShell execution inside .NET programs.

PowerShell Remoting API

APIs and protocols for remote PowerShell execution over WS-Management (WinRM) and SSH. Enables one-to-one and one-to-many remote command and session management.

Collections

PowerShell Gallery API

OPEN

Pricing Plans

Powershell Plans Pricing

3 plans

PLANS

Rate Limits

Powershell Rate Limits

5 limits

RATE LIMITS

FinOps

Powershell Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: PowerShell Gallery API
  version: '2.0'
items:
- info:
    name: Metadata
    type: folder
  items:
  - info:
      name: Retrieve OData service metadata
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/$metadata
    docs: Returns the EDM CSDL describing entity sets, types, and function imports exposed by the Gallery.
- info:
    name: Packages
    type: folder
  items:
  - info:
      name: List packages
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/Packages
      params:
      - name: $filter
        value: ''
        type: query
        description: OData $filter expression.
      - name: $orderby
        value: ''
        type: query
      - name: $top
        value: ''
        type: query
      - name: $skip
        value: ''
        type: query
      - name: $select
        value: ''
        type: query
      - name: semVerLevel
        value: ''
        type: query
    docs: 'Returns the V2FeedPackage entity set. Supports standard OData query options

      such as $filter, $orderby, $top, $skip, $select, $expand.

      '
  - info:
      name: Get a package by Id and Version
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/Packages(Id=':id',Version=':version')
      params:
      - name: id
        value: ''
        type: path
      - name: version
        value: ''
        type: path
    docs: Retrieves a single V2FeedPackage entity by its primary key (Id, Version).
  - info:
      name: Find all versions of a package by Id
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/FindPackagesById()
      params:
      - name: id
        value: ''
        type: query
        description: Quoted package id, e.g. 'PSReadLine'.
      - name: semVerLevel
        value: ''
        type: query
    docs: OData function import returning every published version of the supplied package Id.
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Search packages
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/Search()
      params:
      - name: searchTerm
        value: ''
        type: query
        description: Quoted search expression, e.g. 'Az'.
      - name: targetFramework
        value: ''
        type: query
        description: Quoted target framework moniker.
      - name: includePrerelease
        value: ''
        type: query
      - name: semVerLevel
        value: ''
        type: query
      - name: $top
        value: ''
        type: query
      - name: $skip
        value: ''
        type: query
      - name: $orderby
        value: ''
        type: query
    docs: 'OData function import that searches the Gallery feed using a free-text search

      term, with optional target framework, prerelease, and SemVer level filters.

      '
- info:
    name: Updates
    type: folder
  items:
  - info:
      name: Check for package updates
      type: http
    http:
      method: GET
      url: https://www.powershellgallery.com/api/v2/GetUpdates()
      params:
      - name: packageIds
        value: ''
        type: query
        description: Pipe-delimited, quoted list of package ids.
      - name: versions
        value: ''
        type: query
        description: Pipe-delimited, quoted list of currently installed versions.
      - name: includePrerelease
        value: ''
        type: query
      - name: includeAllVersions
        value: ''
        type: query
      - name: targetFrameworks
        value: ''
        type: query
      - name: versionConstraints
        value: ''
        type: query
      - name: semVerLevel
        value: ''
        type: query
    docs: OData function import that returns available updates for a supplied set of installed packages.
bundled: true