Asset Directory API

The Asset Directory API provides simple RESTful access to files and folders in an asset directory. All API endpoints are accessed through the following base URL:

Asset Directories are represented internally in ProGet as Feeds, so Feed API keys can be used to authenticate to Asset Directories.

The Asset Directory API is comprised of endpoints for both files and folders:

📄 File Management

These endpoints are for directly managing the files located in the asset directory. They are designed to function like a standard web server, so hosted files can be accessed by simple GET requests with support for browser caching.

• Download File - returns the content of a specified file or the files's headers
• Upload File - uploads a specified file to the asset directory
• Delete File - deletes a specified file from the asset directory

📁 Folder Management

These endpoints are for managing the folders located in the asset directory.

• List Folder - describes assets in a specified folder
• Create Folder - creates a new subfolder
• Delete Folder - deletes a specified subfolder
• Export Folder - exports the contents of a folder as either a ZIP or a TGZ archive
• Import Archive - imports the contents of either a ZIP or a TGZ archive as a subfolder

🔖 Metadata Management

The Metadata endpoints allow for reading or updating metadata on a file or folder. These endpoints were added in ProGet v6.0.0.

• Get Metadata - describes the metadata for the specified file or folder
• Update Metadata - updates the Content-Type or the user-defined metadata of a file or folder.

Authenticating to Asset Directory API Endpoints

The following is a summary of access types and their corresponding requirements for various API keys types and endpoints within this API.

To specify an API Key, use the request header (X-ApiKey), querystring (key), or api:«api-key» as the username. See API Key Usage to learn more.

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/endpoints/internal-files/dir/"

Data Specifications

ItemData Object Attributes

ItemData is a set of key/value pairs that correspond to the properties an "item" (either a file or folder) within the Asset Directory. It's used as output data for the List Folder endpoint as a JSON-formatted object.

The content, size, modified and sha1 properties are omitted if the item represents a folder.

JSON Object

{
  "name": "example.txt",
  "parent": "/documents",
  "type": "text/plain",
  "content": "https://proget.corp.local/endpoints/myAssetDirectory/content/documents/example.txt",
  "created": "2023-11-29T09:45:00",
  "modified": "2023-11-29T10:30:00",
  "size": 1024,
  "sha1": "a1b2c3d4e5f6g7h8i9j0"
}

Metadata Object Attributes

Metadata is a set of key/value pairs that correspond to the properties of an item's (file or folder) metadata. It's used as output data for the Get Metadata Endpoint as a JSON-formatted object.

The content, size, modified and sha1 properties are omitted if the item represents a subfolder.

JSON Object

{
  "name": "example.txt",
  "parent": "/documents",
  "type": "text/plain",
  "content": "https://proget.corp.local/endpoints/myAssetDirectory/content/documents/example.txt",
  "created": "2023-11-29T09:45:00",
  "modified": "2023-11-29T10:30:00",
  "size": 1024,
  "sha1": "a1b2c3d4e5f6g7h8i9j0",
  "userMetadata": 
        {
         userMetadata // userMetaData Object
        },
  "cacheHeader": {
    "type": "TTL",
    "value": 30
  }
}

MetadataUpdate Object Attributes

MetadataUpdate is a set of key/value pairs that correspond to the fields in a metadata update. It's used as input data for the Update Metadata Endpoint as a JSON-formatted object.

JSON Object

{
  "type": "application/json",
  "userMetadata": 
        {
         userMetadata // userMetaData Object
        },
  "userMetadataUpdateMode": "update",
  "cacheHeader": 
      {
        "type": "TTL",
        "value": 60
      }
}

Cache Header Settings

See client-side caching for more information.