Library and Manifest

Library

Library package manager possible values:

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

Create a new library catalog entity

POSThttps://app.configure8.io/public/v1/catalog/entities/library

Body

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

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.

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents

requirementsstring

The version requirements for this library

Example: "= 1.1"

provider*string

The provider of the repository where the library resides

providerResourceKeystring

The key/ID of this library in the provider

packageManager*enum

The package manager of this library

Example: "ACTIONS"

ACTIONSNPMPIPMAVENGRADLEGO

packageLabelstring

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

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

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

requirements*string

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

packageName*string

packageManager*string

packageLabelstring

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/library', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "provider": "text",
      "packageManager": "ACTIONS"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:37:34.197Z",
  "lastChangedDateTime": "2024-11-21T06:37:34.197Z",
  "generalAccess": [
    "read"
  ],
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text"
}

Update a library catalog entity

PATCHhttps://app.configure8.io/public/v1/catalog/entities/library/{id}

Path parameters

id*string

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

linksarray of MetadataLinkDto (object)

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

metaTagsarray of MetadataTagDto (object)

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

permissionsobject

permissionsPatternsarray of string

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents, replaces the existing parents 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

packageManager*enum

The package manager of this library

Example: "GO"

ACTIONSNPMPIPMAVENGRADLEGO

packageLabelstring

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

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

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

requirements*string

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

packageName*string

packageManager*string

packageLabelstring

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/library/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "packageManager": "GO"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:37:34.197Z",
  "lastChangedDateTime": "2024-11-21T06:37:34.197Z",
  "generalAccess": [
    "read"
  ],
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text"
}

Manifest

Manifest and repository provider possible values:

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

Create a new manifest catalog entity

POSThttps://app.configure8.io/public/v1/catalog/entities/manifest

Body

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

permissionsobject

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents

repoPath*string

The path of this manifest in the repository

totalDependenciesnumber

The total amount of dependencies that this manifest has

provider*enum

The provider of the repository where the manifest resides

GitHubBitbucketGitLabAzure DevOps

providerResourceKey*string

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

Example: "some/path/package.json"

providerAccountId*string

The key/ID of the account that owns this manifest

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

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

repoPath*string

totalDependencies*number

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/manifest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "repoPath": "text",
      "provider": "GitHub",
      "providerResourceKey": "some/path/package.json",
      "providerAccountId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:37:34.197Z",
  "lastChangedDateTime": "2024-11-21T06:37:34.197Z",
  "generalAccess": [
    "read"
  ],
  "repoPath": "text",
  "totalDependencies": 0,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text"
}

Update a manifest catalog entity

PATCHhttps://app.configure8.io/public/v1/catalog/entities/manifest/{id}

Path parameters

id*string

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

linksarray of MetadataLinkDto (object)

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

metaTagsarray of MetadataTagDto (object)

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

permissionsobject

permissionsPatternsarray of string

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents, replaces the existing parents list

repoPathstring

The path of this manifest in the repository

totalDependenciesnumber

The total amount of dependencies that this manifest has

providerenum

The provider of the repository where the manifest resides

GitHubBitbucketGitLabAzure DevOps

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

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

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

repoPath*string

totalDependencies*number

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/manifest/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:37:34.197Z",
  "lastChangedDateTime": "2024-11-21T06:37:34.197Z",
  "generalAccess": [
    "read"
  ],
  "repoPath": "text",
  "totalDependencies": 0,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text"
}

PreviousEnvironment NextPerson

Last updated 2 months ago

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/library', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "provider": "text", "packageManager": "ACTIONS" }), }); const data = await response.json();

{ "id": "text", "name": "text", "orgId": "text", "type": "application", "description": "text", "metaTags": [ { "name": "text", "value": "text", "type": "JSON", "createdBy": "MANUAL" } ], "links": [ { "url": "text", "title": "text", "icon": "text" } ], "parents": [ { "id": "text", "secondaryId": "text", "label": "belongs_to", "field": "text" } ], "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-11-21T06:37:34.197Z", "lastChangedDateTime": "2024-11-21T06:37:34.197Z", "generalAccess": [ "read" ], "requirements": "text", "provider": "text", "providerType": "text", "providerResourceKey": "text", "providerResourceType": "text", "packageName": "text", "packageManager": "text", "packageLabel": "text" }

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/library/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "packageManager": "GO" }), }); const data = await response.json();

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/manifest', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "repoPath": "text", "provider": "GitHub", "providerResourceKey": "some/path/package.json", "providerAccountId": "text" }), }); const data = await response.json();

{ "id": "text", "name": "text", "orgId": "text", "type": "application", "description": "text", "metaTags": [ { "name": "text", "value": "text", "type": "JSON", "createdBy": "MANUAL" } ], "links": [ { "url": "text", "title": "text", "icon": "text" } ], "parents": [ { "id": "text", "secondaryId": "text", "label": "belongs_to", "field": "text" } ], "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-11-21T06:37:34.197Z", "lastChangedDateTime": "2024-11-21T06:37:34.197Z", "generalAccess": [ "read" ], "repoPath": "text", "totalDependencies": 0, "provider": "text", "providerType": "text", "providerResourceKey": "text", "providerResourceType": "text", "providerAccountId": "text" }

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/manifest/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "id": "text", "name": "text", "orgId": "text", "type": "application", "description": "text", "metaTags": [ { "name": "text", "value": "text", "type": "JSON", "createdBy": "MANUAL" } ], "links": [ { "url": "text", "title": "text", "icon": "text" } ], "parents": [ { "id": "text", "secondaryId": "text", "label": "belongs_to", "field": "text" } ], "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-11-21T06:37:34.197Z", "lastChangedDateTime": "2024-11-21T06:37:34.197Z", "generalAccess": [ "read" ], "repoPath": "text", "totalDependencies": 0, "provider": "text", "providerType": "text", "providerResourceKey": "text", "providerResourceType": "text", "providerAccountId": "text" }