Feed Management - Get Feed

Service:

Artifacts

API Version:

7.1

Get the settings for a specific feed.

The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?api-version=7.1

With optional parameters:

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?includeDeletedUpstreams={includeDeletedUpstreams}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
feedId	path	True	string	Name or Id of the feed.
organization	path	True	string	The name of the Azure DevOps organization.
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.
includeDeletedUpstreams	query		boolean	Include upstreams that have been deleted in the response.

Responses

Name	Type	Description
200 OK	Feed	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	Grants the ability to read feeds and packages. Also grants the ability to search packages.

Definitions

Name	Description
Feed	A container for artifacts.
FeedCapabilities	Supported capabilities of a feed.
FeedPermission	Permissions for a feed.
FeedRole	The role for this identity on a feed.
FeedView	A view on top of a feed.
FeedViewType	Type of view.
FeedVisibility	Visibility status of the view.
IdentityDescriptor	An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID.
ProjectReference
ReferenceLinks	The class to represent a collection of REST reference links.
UpstreamSource	Upstream source definition, including its Identity, package type, and other associated information.
UpstreamSourceType	Source type, such as Public or Internal.
UpstreamStatus	Specifies the status of the upstream.
UpstreamStatusDetail

Feed

A container for artifacts.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
badgesEnabled	boolean	If set, this feed supports generation of package badges.
capabilities	FeedCapabilities	Supported capabilities of a feed.
defaultViewId	string	The view that the feed administrator has indicated is the default experience for readers.
deletedDate	string	The date that this feed was deleted.
description	string	A description for the feed. Descriptions must not exceed 255 characters.
fullyQualifiedId	string	This will either be the feed GUID or the feed GUID and view GUID depending on how the feed was accessed.
fullyQualifiedName	string	Full name of the view, in feed@view format.
hideDeletedPackageVersions	boolean	If set, the feed will hide all deleted/unpublished versions
id	string	A GUID that uniquely identifies this feed.
isReadOnly	boolean	If set, all packages in the feed are immutable. It is important to note that feed views are immutable; therefore, this flag will always be set for views.
name	string	A name for the feed. feed names must follow these rules: Must not exceed 64 characters Must not contain whitespaces Must not start with an underscore or a period Must not end with a period Must not contain any of the following illegal characters: , |, /, \\, ?, :, &, $, *, \", #, [, ] ]]>
permanentDeletedDate	string	The date that this feed was permanently deleted.
permissions	FeedPermission[]	Explicit permissions for the feed.
project	ProjectReference	The project that this feed is associated with.
scheduledPermanentDeleteDate	string	The date that this feed is scheduled to be permanently deleted.
upstreamEnabled	boolean	This should always be true. Setting to false will override all sources in UpstreamSources.
upstreamEnabledChangedDate	string	If set, time that the UpstreamEnabled property was changed. Will be null if UpstreamEnabled was never changed after Feed creation.
upstreamSources	UpstreamSource[]	A list of sources that this feed will fetch packages from. An empty list indicates that this feed will not search any additional sources for packages.
url	string	The URL of the base feed in GUID form.
view	FeedView	Definition of the view.
viewId	string	View Id.
viewName	string	View name.

FeedCapabilities

Supported capabilities of a feed.

Name	Type	Description
defaultCapabilities	string	The capabilities given to a newly created feed
none	string	No flags exist for this feed
underMaintenance	string	This feed is currently under maintenance and may have reduced functionality
upstreamV2	string	This feed can serve packages from upstream sources Upstream packages must be manually promoted to views

FeedPermission

Permissions for a feed.

Name	Type	Description
displayName	string	Display name for the identity.
identityDescriptor	IdentityDescriptor	Identity associated with this role.
identityId	string	Id of the identity associated with this role.
isInheritedRole	boolean	Boolean indicating whether the role is inherited or set directly.
role	FeedRole	The role for this identity on a feed.

FeedRole

The role for this identity on a feed.

Name	Type	Description
administrator	string	Administrators have total control over the feed.
collaborator	string	Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources.
contributor	string	Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings.
custom	string	Unsupported.
none	string	Unsupported.
reader	string	Readers can only read packages and view settings.

FeedView

A view on top of a feed.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
id	string	Id of the view.
name	string	Name of the view.
type	FeedViewType	Type of view.
url	string	Url of the view.
visibility	FeedVisibility	Visibility status of the view.

FeedViewType

Type of view.

Name	Type	Description
implicit	string	Internal view type that is automatically created and managed by the system.
none	string	Default, unspecified view type.
release	string	View used as a promotion destination to classify released artifacts.

FeedVisibility

Visibility status of the view.

Name	Type	Description
aadTenant	string	Feed is accessible by all the valid users present in the Azure Active Directory tenant.
collection	string	Feed is accessible by all the valid users present in the organization where the feed resides (for example across organization 'myorg' at 'dev.azure.com/myorg')
organization	string	Feed is accessible by all the valid users present in the enterprise where the feed resides. Note that legacy naming and back compat leaves the name of this value out of sync with its new meaning.
private	string	Only accessible by the permissions explicitly set by the feed administrator.

IdentityDescriptor

An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID.

Name	Type	Description
identifier	string	The unique identifier for this identity, not exceeding 256 chars, which will be persisted.
identityType	string	Type of descriptor (for example, Windows, Passport, etc.).

ProjectReference

Name	Type	Description
id	string	Gets or sets id of the project.
name	string	Gets or sets name of the project.
visibility	string	Gets or sets visibility of the project.

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.

UpstreamSource

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

Name	Type	Description
deletedDate	string	UTC date that this upstream was deleted.
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.
internalUpstreamCollectionId	string	For an internal upstream type, track the Azure DevOps organization that contains it.
internalUpstreamFeedId	string	For an internal upstream type, track the feed id being referenced.
internalUpstreamProjectId	string	For an internal upstream type, track the project of the feed being referenced.
internalUpstreamViewId	string	For an internal upstream type, track the view of the feed being referenced.
location	string	Consistent locator for connecting to the upstream source.
name	string	Display name.
protocol	string	Package type associated with the upstream source.
serviceEndpointId	string	The identity of the service endpoint that holds credentials to use when accessing the upstream.
serviceEndpointProjectId	string	Specifies the projectId of the Service Endpoint.
status	UpstreamStatus	Specifies the status of the upstream.
statusDetails	UpstreamStatusDetail[]	Provides a human-readable reason for the status of the upstream.
upstreamSourceType	UpstreamSourceType	Source type, such as Public or Internal.

UpstreamSourceType

Source type, such as Public or Internal.

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

UpstreamStatus

Specifies the status of the upstream.

Name	Type	Description
disabled	string	Upstream source is disabled.
ok	string	Upstream source is ok.

UpstreamStatusDetail

Name	Type	Description
reason	string	Provides a human-readable reason for the status of the upstream.