Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-1711418.5 KB

Updates a package

post/packages/{packageId}

Path parameters

packageIdstring required

Package id

Request body

idstring required

Package id

namestring

Package name

machine_namestring

Package name (for machines)

domainstring

Package domain

versionstring

Package version

created_atstring date-time

Package creation date

updated_atstring date-time

Package last update date

published_atstring date-time

Package publication date

logo_urlstring

Package logo url

contact_emailstring

Package contact email

legal_info_urlstring

Package legal info url

descriptionstring

Package description

machine_descriptionstring

Package description (for machines)

user_idstring

Package owner user id

openapistring

Package OpenAPI specification

Example request

{
  "name": "Acme",
  "machine_name": "acme",
  "domain": "acme.com",
  "version": "1.0.0",
  "created_at": "2019-01-01T00:00:00Z",
  "updated_at": "2019-01-01T00:00:00Z",
  "published_at": "2019-01-01T00:00:00Z",
  "logo_url": "https://logo.clearbit.com/acme.com",
  "contact_email": "support@acme.com",
  "legal_info_url": "https://acme.com/legal",
  "description": "Acme is an API for searching and retrieving information about Acme's products.",
  "machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
  "openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}

Response

A package

idstring required

Package id

namestring

Package name

machine_namestring

Package name (for machines)

domainstring

Package domain

versionstring

Package version

created_atstring date-time

Package creation date

updated_atstring date-time

Package last update date

published_atstring date-time

Package publication date

logo_urlstring

Package logo url

contact_emailstring

Package contact email

legal_info_urlstring

Package legal info url

descriptionstring

Package description

machine_descriptionstring

Package description (for machines)

user_idstring

Package owner user id

openapistring

Package OpenAPI specification

Example response

{
  "name": "Acme",
  "machine_name": "acme",
  "domain": "acme.com",
  "version": "1.0.0",
  "created_at": "2019-01-01T00:00:00Z",
  "updated_at": "2019-01-01T00:00:00Z",
  "published_at": "2019-01-01T00:00:00Z",
  "logo_url": "https://logo.clearbit.com/acme.com",
  "contact_email": "support@acme.com",
  "legal_info_url": "https://acme.com/legal",
  "description": "Acme is an API for searching and retrieving information about Acme's products.",
  "machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
  "openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}