Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ArtefactVersion

Register a new Artefact Version with your organization.

post/orgs/{orgId}/artefact-versions

Path parameters

orgIdstring required

The organization ID.

Query parameters

vcsstring

(Optional) Which version control system the version comes from. Default value is "git". If this parameter is not supplied or its value is "git", the provided ref, if not empty, is checked to ensure that it has the prefix "refs/".

dry_runboolean

Optionally validate the request but do not persist the actual artefact. If the Accept type is set to "application/x.workload-deployment-set+json" or "application/x.workload-deployment-set+x-yaml", the generated deployment set will be returned.

Headers

Acceptstring

Indicates which content types the client is able to understand.

Request body

OR

Example request

{
  "type": "container",
  "name": "registry.humanitec.io/my-org/my-service",
  "version": "1.2.7",
  "ref": "refs/heads/main",
  "commit": "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
  "digest": "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244"
}

Response

An Artefact Version.

OR

Example response

{
  "type": "container",
  "artefact_id": "01234567-89ab-cdef-0123-456789abcdef",
  "commit": "060c3d6530a881afb808f105f36af25e1ad1b2f3",
  "created_at": "2020-06-22T09:37:23.523Z",
  "created_by": "01234567-89ab-cdef-0123-456789abcdef",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "registry.humanitec.io/my-org/my-service",
  "ref": "refs/heads/main",
  "updated_at": "2020-06-22T09:37:23.523Z",
  "updated_by": "01234567-89ab-cdef-0123-456789abcdef",
  "version": "1.2.7",
  "digest": "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244"
}