packages

Create a new Composer package

Create a new Composer package

post/packages/{owner}/{repo}/upload/composer/

Request body

package_filestring required

The primary file for the package.

republishboolean

If true, the uploaded package will overwrite any others with the same attributes (e.g. same version); otherwise, it will be flagged as a duplicate.

tagsstring nullable

A comma-separated values list of tags to add to the package.

versionstring nullable

The raw version for this package.

Response

Upload acknowledged and queued for synchronization.

cdn_urlstring nullable
checksum_md5string
checksum_sha1string
checksum_sha256string
checksum_sha512string
dependencies_checksum_md5string nullable

A checksum of all of the package's dependencies.

dependencies_urlstring uri
descriptionstring nullable

A textual description of this package.

display_namestring
downloadsinteger
epochinteger nullable

The epoch of the package version (if any).

extensionstring
filenamestring
formatstring
format_urlstring uri
freeable_storageinteger

Amount of storage that will be freed if this package is deleted

fully_qualified_namestring nullable
identifier_permstring

Unique and permanent identifier for the package.

identifiersobject

Return a map of identifier field names and their values.

indexedboolean
is_cancellableboolean
is_copyableboolean
is_deleteableboolean
is_downloadableboolean
is_hiddenboolean
is_moveableboolean
is_quarantinableboolean
is_quarantinedboolean
is_resyncableboolean
is_security_scannableboolean
is_sync_awaitingboolean
is_sync_completedboolean
is_sync_failedboolean
is_sync_in_flightboolean
is_sync_in_progressboolean
licensestring nullable

The license of this package.

namestring nullable

The name of this package.

namespacestring
namespace_urlstring uri
num_filesinteger
origin_repositorystring
origin_repository_urlstring uri
osi_approvedboolean

Whether the package's SPDX license is OSI-approved.

package_type1 | 2 | 3 | 9

The type of package contents.

policy_violatedboolean

Whether or not the package has violated any policy.

raw_licensestring nullable

The raw license string.

releasestring nullable

The release of the package version (if any).

repositorystring
repository_urlstring uri
security_scan_completed_atstring date-time nullable

The datetime the security scanning was completed.

security_scan_started_atstring date-time nullable

The datetime the security scanning was started.

security_scan_status'Awaiting Security Scan' | 'Security Scanning in Progress' | 'Scan Detected Vulnerabilities' | 'Scan Detected No Vulnerabilities' | 'Security Scanning Disabled' | 'Security Scanning Failed' | 'Security Scanning Skipped' | 'Security Scanning Not Supported' nullable
security_scan_status_updated_atstring date-time nullable

The datetime the security scanning status was updated.

self_html_urlstring
self_urlstring uri
self_webapp_urlstring
signature_urlstring nullable
sizeinteger

The calculated size of the package.

slugstring slug

The public unique identifier for the package.

slug_permstring slug
spdx_licensestring nullable

The SPDX license identifier for this package.

stage0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

The synchronisation (in progress) stage of the package.

stage_strstring
stage_updated_atstring date-time

The datetime the package stage was updated at.

status1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

The synchronisation status of the package.

status_reasonstring nullable

A textual description for the synchronous status reason (if any

status_strstring
status_updated_atstring date-time

The datetime the package status was updated at.

status_urlstring uri
store_pathstring nullable

Absolute store path for the package, including store hash and name.

subtypestring
summarystring nullable

A one-liner synopsis of this package.

sync_finished_atstring date-time nullable

The datetime the package sync was finished at.

sync_progressinteger

Synchronisation progress (from 0-100)

tags_automaticTags

All tags on the package, grouped by tag type. This includes immutable tags, but doesn't distinguish them from mutable. To see which tags are immutable specifically, see the tags_immutable field.

tags_immutableTags

All tags on the package, grouped by tag type. This includes immutable tags, but doesn't distinguish them from mutable. To see which tags are immutable specifically, see the tags_immutable field.

tags_staticobject

All static tags on the package, grouped by context. Static tags are derived from the package's properties at request time and carry a 'context' (rather than a tag type). Includes format-specific badges and the package's architecture, subtype, and extension.

type_displaystring
uploaded_atstring date-time

The date this package was uploaded.

uploaderstring
uploader_urlstring uri
versionstring nullable

The raw version for this package.

version_origstring
vulnerability_scan_results_urlstring uri

Changes

No recorded changes to this endpoint across all 1 revision of this API.