Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NuGet Service Index API

The service index is the entry point for the NuGet V3 API. It is a JSON document that lists all available resources and their capabilities.

NuGet Service Index API is one of 7 APIs that NuGet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.nuget.org/v3/catalog0.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Server
https://api.nuget.org/v3/catalog0
Terms of Service
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Service Index 1

The service index is the entry point for the NuGet V3 API. It is a JSON document that lists all available resources and their capabilities.

GET
/index.json
Get the service index
getServiceIndex → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ServiceIndexResource (3 properties), ServiceIndex (2 properties). Each schema is shown below with its type and property counts.

ServiceIndex
object
The service index document that lists all available NuGet API resources.
2 properties 2 required
ServiceIndexResource
object
A resource available on the NuGet package source.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuget-service-index-api-openapi.yml Raw ↑

Other APIs NuGet publishes across the network.

NuGet Catalog API
NuGet Search API
NuGet Package Content API
NuGet Autocomplete API
NuGet Package Publish API
NuGet Registration API