Skip to main content
POST
Register a package mirror

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string
required

Lowercase letters, digits and '-'; 1–40 characters.

index_url
string
required

pip index URL of the mirror (the /simple endpoint).

ca_cert_pem
string | null

PEM CA certificate if the mirror uses an internal CA.

enabled
boolean
default:true

Response

Successful Response

name
string
required
kind
enum<string>
required
Available options:
pypi,
mirror,
preinstalled
enabled
boolean
required
is_default
boolean
required
description
string
required
index_url
string | null
ca_cert_pem
string | null