Npm - Update Package

Reference

Service:: Artifacts Package Types

API Version:: 7.1

PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/{packageName}/versions/{packageVersion}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
feedId	path	True	string
organization	path	True	string	The name of the Azure DevOps organization.
packageName	path	True	string
packageVersion	path	True	string
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name	Type	Description
deprecateMessage	string	Indicates the deprecate message of a package version
views	JsonPatchOperation	The view to which the package version will be added

Responses

Name	Type	Description
200 OK	Package	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.packaging_manage	Grants the ability to create, read, update, and delete feeds and packages.

Definitions

Name	Description
JsonPatchOperation	The JSON model for a JSON Patch operation
Operation	The patch operation
Package	Package version metadata for an npm package
PackageVersionDetails
PackagingSourceType	Source type, such as Public or Internal.
ReferenceLinks	The class to represent a collection of REST reference links.
UpstreamSourceInfo	Upstream source definition, including its Identity, package type, and other associated information.

JsonPatchOperation

The JSON model for a JSON Patch operation

Name	Type	Description
from	string	The path to copy from for the Move/Copy operation.
op	Operation	The patch operation
path	string	The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).
value	object	The value for the operation. This is either a primitive or a JToken.

Operation

The patch operation

Name	Type	Description
add	string
copy	string
move	string
remove	string
replace	string
test	string

Package

Package version metadata for an npm package

Name	Type	Description
_links	ReferenceLinks	Related REST links.
deprecateMessage	string	Deprecated message, if any, for the package.
id	string	Package Id.
name	string	The display name of the package.
permanentlyDeletedDate	string	If and when the package was permanently deleted.
sourceChain	UpstreamSourceInfo[]	The history of upstream sources for this package. The first source in the list is the immediate source from which this package was saved.
unpublishedDate	string	If and when the package was deleted.
version	string	The version of the package.

PackageVersionDetails

Name	Type	Description
deprecateMessage	string	Indicates the deprecate message of a package version
views	JsonPatchOperation	The view to which the package version will be added

PackagingSourceType

Source type, such as Public or Internal.

Name	Type	Description
internal	string	Azure DevOps upstream source.
public	string	Publicly available source.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

UpstreamSourceInfo

Upstream source definition, including its Identity, package type, and other associated information.

Name	Type	Description
displayLocation	string	Locator for connecting to the upstream source in a user friendly format, that may potentially change over time
id	string	Identity of the upstream source.
location	string	Locator for connecting to the upstream source
name	string	Display name.
sourceType	PackagingSourceType	Source type, such as Public or Internal.

Share via