Library and Manifest

• Library

  • Create a library entity

  • Update a library entity

• Manifest

  • Create a manifest entity

  • Update a manifest entity

Library

Library package manager possible values:

"ACTIONS", "NPM", "PIP", "MAVEN", "GRADLE", and "GO"

Create a new library catalog entity

post

/public/v1/catalog/entities/library

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

requirementsstring

The version requirements for this library

Example: = 1.1

providerstringrequired

The provider of the repository where the library resides

providerResourceKeystring

The key/ID of this library in the provider

packageLabelstring

The label of this library. Defaults to the name of the entity

packageManagerstring · enumrequired

The package manager of this library

Example: ACTIONS

Options: ACTIONS, NPM, PIP, MAVEN, GRADLE, GO

linksobject[]

List of URLs linked to this entity

metaTagsobject[]

List of metadata tags linked to this entity

parentsobject[]

Catalog entity's parents

generalAccessstring · enum[]

Entity visibility control. By default it is set to a default access control on organization level

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/entities/library' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","requirements":"= 1.1","provider":"text","packageManager":"ACTIONS","links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

201

401

403

409

422

201

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:09:00.377Z",
  "lastChangedDateTime": "2025-02-21T18:09:00.377Z",
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Update a library catalog entity

patch

/public/v1/catalog/entities/library/{id}

Path parameters

idstringrequired

ID of the catalog entity.

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

replaceMetadataTagsboolean

Replace metadata tags with the provided list

requirementsstring

The version requirements for this library

Example: > 2.2

providerstring

The provider of the repository where the library resides

providerResourceKeystring

The key/ID of this library in the provider

packageLabelstring

The label of this library. Defaults to the name of the entity

packageManagerstring · enumrequired

The package manager of this library

Example: GO

Options: ACTIONS, NPM, PIP, MAVEN, GRADLE, GO

linksobject[]

List of URLs linked to this entity, replaces the existing list

metaTagsobject[]

List of metadata tags linked to this entity, replaces the existing list

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

generalAccessstring · enum[]

Entity visibility control. By default it is set to a default access control on organization level

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/catalog/entities/library/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"requirements":"> 2.2","packageManager":"GO","links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"permissionsPatterns":[null],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

200

401

403

404

409

422

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:09:00.377Z",
  "lastChangedDateTime": "2025-02-21T18:09:00.377Z",
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Manifest

Manifest and repository provider possible values:

"GitHub", "Bitbucket", "GitLab", "Azure DevOps"

Create a new manifest catalog entity

post

/public/v1/catalog/entities/manifest

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

repoPathstringrequired

The path of this manifest in the repository

totalDependenciesnumber

The total amount of dependencies that this manifest has

providerResourceKeystringrequired

The key/ID of this manifest. Typically the path of the file containing dependencies

Example: some/path/package.json

providerAccountIdstringrequired

The key/ID of the account that owns this manifest

providerstring · enumrequired

The provider of the repository where the manifest resides

Options: GitHub, Bitbucket, GitLab, Azure DevOps

linksobject[]

List of URLs linked to this entity

metaTagsobject[]

List of metadata tags linked to this entity

parentsobject[]

Catalog entity's parents

generalAccessstring · enum[]

Entity visibility control. By default it is set to a default access control on organization level

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/entities/manifest' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","repoPath":"text","providerResourceKey":"some/path/package.json","providerAccountId":"text","provider":"GitHub","links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

201

401

403

409

201

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:09:00.377Z",
  "lastChangedDateTime": "2025-02-21T18:09:00.377Z",
  "repoPath": "text",
  "totalDependencies": 1,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Update a manifest catalog entity

patch

/public/v1/catalog/entities/manifest/{id}

Path parameters

idstringrequired

ID of the catalog entity.

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

replaceMetadataTagsboolean

Replace metadata tags with the provided list

repoPathstring

The path of this manifest in the repository

totalDependenciesnumber

The total amount of dependencies that this manifest has

providerResourceKeystring

The key/ID of this manifest. Typically the path of the file containing dependencies

Example: some/path/package.json

providerAccountIdstring

The key/ID of the account that owns this manifest

providerstring · enum

The provider of the repository where the manifest resides

Options: GitHub, Bitbucket, GitLab, Azure DevOps

linksobject[]

List of URLs linked to this entity, replaces the existing list

metaTagsobject[]

List of metadata tags linked to this entity, replaces the existing list

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

generalAccessstring · enum[]

Entity visibility control. By default it is set to a default access control on organization level

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/catalog/entities/manifest/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"providerResourceKey":"some/path/package.json","provider":"GitHub","links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"permissionsPatterns":[null],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

200

401

403

404

409

422

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:09:00.377Z",
  "lastChangedDateTime": "2025-02-21T18:09:00.377Z",
  "repoPath": "text",
  "totalDependencies": 1,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}