Update Repository Configuration

post

https://{jfrog_url}/artifactory/api/repositories/{repoKey}

Updates an existing repository configuration in Artifactory with the provided configuration elements. Supported by local, remote, virtual, and Federated repositories.

Since: 2.3.0

Supported JFrog Subscriptions: Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise or Enterprise+ subscription.

The class of a repository (rclass) cannot be updated. To enable CDN Distribution, set the cdnRedirect flag; applies to Artifactory Cloud and requires an Enterprise or Enterprise+ license.

Security: Requires an admin user.

Additional examples of repository configuration can be found at: https://docs.jfrog.com/integrations/docs/configuration-json-files#repository-configuration-json

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

repoKey

string

required

The repository key

Body Params

Partial or full repository configuration JSON. Same vendor media types and per-rclass rules as Create Repository. The class rclass cannot be changed; optional fields may be omitted on update when not required.

Local repository configuration JSON. Vendor media type application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json. Required vs optional fields and defaults are described on each property below.

key

string

required

Repository key (mandatory on create).

rclass

string

enum

required

Must be local.

Allowed:

projectKey

string

Project key; when assigning the repo to a project, environments is mandatory.

environments

array of strings

Mandatory when assigning repository to a project.

environments

packageType

string

enum

Allowed packageType values for local repositories.

description

string

Public description of the repository.

notes

string

Internal notes.

includesPattern

string

Default **/*; empty string also includes everything.

excludesPattern

string

repoLayoutRef

string

Default maven-2-default where applicable.

debianTrivialLayout

boolean

checksumPolicyType

string

enum

Checksum policy (local and federated repository configuration).

Allowed:

handleReleases

boolean

Default true.

handleSnapshots

boolean

Default true.

maxUniqueSnapshots

integer

maxUniqueTags

integer

snapshotVersionBehavior

string

enum

Maven SNAPSHOT naming; default unique from 7.41 (affects local and federated).

Allowed:

suppressPomConsistencyChecks

boolean

blackedOut

boolean

xrayIndex

boolean

propertySets

array of strings

propertySets

archiveBrowsingEnabled

boolean

calculateYumMetadata

boolean

yumRootDepth

integer

dockerApiVersion

string

enum

Default V2 (Docker API version).

Allowed:

terraformType

string

enum

Allowed:

enableFileListsIndexing

string

optionalIndexCompressionFormats

array of strings

optionalIndexCompressionFormats

downloadRedirect

string

cdnRedirect

string

Artifactory Cloud; Enterprise or Enterprise+ license when enabled.

blockPushingSchema1

string

primaryKeyPairRef

string

secondaryKeyPairRef

string

forceNugetAuthentication

boolean

forceP2Authentication

boolean

forceConanAuthentication

boolean

encryptStates

boolean

priorityResolution

string

Default false; applies to all repository types excluding CocoaPods, Git LFS, NuGet V2, Opkg, Rust, Vagrant, VCS.

contentSynchronisation

object

Smart Remote Repository; set enabled under this object.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Repository configuration updated; response body is plain text confirmation, not JSON.

400Bad Request — invalid configuration.

401Bad Credentials — the provided authentication is invalid.

403Permission Denied — the user does not have the necessary permissions to perform this action (admin required).

404Not Found — the specified resource was not found.

500Internal Server Error