API Documentation

Configure8 API documentation

The Configure8 API is based on REST architecture style. The API uses standard HTTP verbs, codes and authentication. Endpoints accept and return JSON-encoded data.

Authentication

Configure8 API is protected by API keys. In order to use our API, you need to set up a key with appropriate scopes and role. You can refer to the API keys management section in our documentation to check out more detailed information.

Please make sure that you are not exposing your API keys. Keep them secure and do not share them publicly!

Configure8 API keys start with c8ak prefix, so they support secret scanning (i. e. Github secret scanning) to help you to avoid exposing API keys.

Authentication is performed via Api-Key Header. All API calls must be authenticated and made over HTTPS.

curl https://app.configure8.io/public/v1/catalog/entities \
--header "Api-Key: my_api_key" 

Errors

As for errors, Configure8 API uses standard HTTP status codes. Below you see the most common status codes and possible reasons.

Status code	Description
2xx	OK
400	Bad request. Possible reason - malformed request (i.e. body, params).
401	Unauthorised. The API key is invalid or was not provided.
403	Forbidden. The does not have enough permissions to perform this operation.
404	Not found. Requested entity is not found.
409	Conflict. Usually caused by duplicating names in resources, incorrect template usage on entity creation etc.
422	Unprocessable entity. The request syntax is correct, but there is a business logic error from the client's side.
5xx	Configure8 internal server error.

Pagination

Endpoints that return multiple items (e. g. /public/v1/catalog/entities) contain pagination for more convenient usage. It is based on such properties: pageNumber, pageSize and sort.

Property	Default	Description
pageNumber	0	Page to return. Offset to return is calculated based on pageNumber * pageSize
pageSize	20	Number of items to return
sort	Sorted by name in ascending order	Sorting of items is defined by this structure: { property: 'propertyToSortOn', order: 'ASC' | 'DESC' }

Endpoints

Catalog Entity

Get catalog entities filtered by query.

POST/public/v1/catalog/entities

Body

application/json

propertyFiltersarray of one of

Filters for matching properties' values: Can be SIMPLE and COMPOUND. SIMPLE is a key-value pair. COMPOUND is a set of key-value pairs combined with OR or AND operator

searchTermsstring

Term to search by

searchOnlyByNameboolean

Perform search only by entity name. By default search will be performed considering all text properties

typesarray of enum

Catalog entity types to filter by

includePropertiesarray of string

Entity properties that will be returned in result. By default all entity properties are included in response. If includeProperties is passed, regardless of which properties are specified, 'id' and 'type' fields will be always included

pageNumbernumber

pageSizenumber

sortall of

Sort entities by property in ASC or DESC order

Response

200400

Body

application/json

totalFound*number

Total elements found

pageNumber*number

pageSize*number

items*array of CatalogEntityDto (object)

Found catalog entities

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "tags": [
        "text"
      ],
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "label": "belongs_to"
        }
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-04-28T18:31:45.246Z",
      "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
      "generalAccess": [
        "read"
      ]
    }
  ]
}

Get a catalog entity by id.

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

Path parameters

id*string

Unique id of catalog entity to return

Response

200404

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Delete the specified catalog entity

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

Path parameters

id*any

Unique ID for given catalog entity.

Response

200404409

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

NB: Only meta tags and tags can be updated for discovery created resources

Create a new resource catalog entity

POST/public/v1/catalog/entities/resource

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

providerResourceKey*string

The key/ID of the resource in the provider

provider*string

Provider name

providerResourceType*string

Provider resource type

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

parentsarray of EntityParentDto (object)

Catalog resource's parents

deepLinkUrlstring

Deep link to the resource

Response

201409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

detailsobject

deepLinkUrlstring

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/resource', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "providerResourceKey": "text",
      "provider": "text",
      "providerResourceType": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "deepLinkUrl": "text"
}

Update a resource catalog entity

PATCH/public/v1/catalog/entities/resource/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

providerResourceKeystring

The key/ID of the resource in the provider

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

parentsarray of EntityParentDto (object)

Catalog resource's parents, replaces the existing parents list

deepLinkUrlstring

Deep link to the resource

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

detailsobject

deepLinkUrlstring

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/resource/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "deepLinkUrl": "text"
}

Create a new person catalog entity

POST/public/v1/catalog/entities/person

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

email*string

The email of this person

userIdstring

The ID of the user linked to this person

photoUrlstring

An optional URL of a photo/image to display for this person

familyNamestring

User family name

givenNamestring

User given name

externalIdstring

User external id

Response

201409

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

email*string

The email of this person

userIdstring

The ID of the user linked to this person

photoUrlstring

An optional URL of a photo/image to display for this person

familyNamestring

User family name

givenNamestring

User given name

externalIdstring

User external id

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/person', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "email": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "tags": [
    "text"
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "email": "text",
  "userId": "text",
  "photoUrl": "text",
  "familyName": "text",
  "givenName": "text",
  "externalId": "text"
}

Update a person catalog entity

PATCH/public/v1/catalog/entities/person/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

photoUrlstring

Person photo url

familyNamestring

Person family name

givenNamestring

Person givenName name

Response

200404409

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

email*string

isActive*boolean

userIdstring

externalIdstring

familyNamestring

givenNamestring

photoUrlstring

provisionedboolean

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/person/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "email": "text",
  "isActive": false,
  "userId": "text",
  "externalId": "text",
  "familyName": "text",
  "givenName": "text",
  "photoUrl": "text",
  "provisioned": false
}

Create a new service catalog entity

POST/public/v1/catalog/entities/service

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

repositoryIdstring

The ID of the repository entity to assign to the service

repositoryPathstring

The path of the repository

languagesarray of string

The languages that this service uses

lifecyclestring

The lifecycle of the service

applicationsarray of string

The ID of the application entities linked to this service

templateIdstring

The ID of the template that this entity is based on

Response

201404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

repositoryPathstring

languagesarray of string

lifecyclestring

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/service', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "repositoryPath": "text",
  "languages": [
    "text"
  ],
  "lifecycle": "text"
}

Update a service catalog entity

PATCH/public/v1/catalog/entities/service/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

repositoryIdstring

The ID of the repository entity to assign to the service

repositoryPathstring

The path of the repository

languagesarray of string

The languages that this service uses

lifecyclestring

The lifecycle of the service

applicationsarray of string

The ID of the application entities linked to this service

templateIdstring

The ID of the template that this service is based on

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

repositoryPathstring

languagesarray of string

lifecyclestring

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/service/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "repositoryPath": "text",
  "languages": [
    "text"
  ],
  "lifecycle": "text"
}

Create a new environment catalog entity

POST/public/v1/catalog/entities/environment

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

Response

201404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/environment', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Update an environment catalog entity

PATCH/public/v1/catalog/entities/environment/{id}

Path parameters

id*string

ID of the catalog entity.

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/environment/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Create a new system catalog entity

POST/public/v1/catalog/entities/system

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

Response

201409

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Update a system catalog entity

PATCH/public/v1/catalog/entities/system/{id}

Path parameters

id*string

ID of the catalog entity.

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

Response

200404409

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/system/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Create a new application catalog entity

POST/public/v1/catalog/entities/application

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

Response

201409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Update an application catalog entity

PATCH/public/v1/catalog/entities/application/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/application/{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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Library packageManager possible values:

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

Create a new library catalog entity

POST/public/v1/catalog/entities/library

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

requirementsstring

The version requirements for this library

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

ACTIONSNPMPIPMAVENGRADLEGO

packageLabelstring

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

Response

201409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

requirements*string

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

packageName*string

packageManager*string

packageLabelstring

Request

JavaScriptCurl

const response = await fetch('/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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text"
}

Update a library catalog entity

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

Path parameters

id*string

ID of the catalog entity.

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

requirementsstring

The version requirements for this library

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

ACTIONSNPMPIPMAVENGRADLEGO

packageLabelstring

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

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

requirements*string

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

packageName*string

packageManager*string

packageLabelstring

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "requirements": "text",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "packageName": "text",
  "packageManager": "text",
  "packageLabel": "text"
}

Manifest and repository provider possible values:

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

Create an new repository catalog entity

POST/public/v1/catalog/entities/repository

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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

url*string

The URL of the repository

contributorsarray of RepositoryContributorDto (object)

The list of constributors for this repository

languagesarray of RepositoryLanguageDto (object)

The languages that this repository uses

releaseall of

The latest release of this repository

provider*enum

The provider of this repository

GitHubBitbucketGitLabAzure DevOps

providerResourceKey*string

The key/ID of this repository in the provider

providerAccountId*string

The key/ID of the account that owns this repository

location*string

The full path of the repository

locationGroupstring

The repository project path for nested project providers like GitLab. It can be set to "None" if not applicable.

Response

201404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecost

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

url*string

contributors*array of string

languages*array of string

release*RepositoryReleaseDto (object)

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

locationGroupstring

detailsobject

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/repository', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "url": "text",
      "provider": "GitHub",
      "providerResourceKey": "text",
      "providerAccountId": "text",
      "location": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "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-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "url": "text",
  "contributors": [
    "text"
  ],
  "languages": [
    "text"
  ],
  "release": {
    "name": "text",
    "date": "text",
    "tag": "text",
    "latest": false
  },
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "locationGroup": "text"
}

Update a repository catalog entity

PATCH/public/v1/catalog/entities/repository/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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.

permissionsPatternsarray of string

generalAccessarray of enum

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

urlstring

The URL of the repository

contributorsarray of RepositoryContributorDto (object)

The list of contributors for this repository

languagesarray of RepositoryLanguageDto (object)

The languages that this repository uses

releaseall of

The latest release of this repository

provider*enum

The provider of this repository

GitHubBitbucketGitLabAzure DevOps

providerResourceKeystring

The key/ID of this repository in the provider

providerAccountIdstring

The key/ID of the account that owns this repository

locationstring

The full path of the repository

locationGroupstring

The repository project path for nested project providers like GitLab. It can be set to "None" if not applicable.

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecost

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

url*string

contributors*array of string

languages*array of string

release*RepositoryReleaseDto (object)

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

locationGroupstring

detailsobject

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "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-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "url": "text",
  "contributors": [
    "text"
  ],
  "languages": [
    "text"
  ],
  "release": {
    "name": "text",
    "date": "text",
    "tag": "text",
    "latest": false
  },
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "locationGroup": "text"
}

Create a new manifest catalog entity

POST/public/v1/catalog/entities/manifest

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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 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

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

providerAccountId*string

The key/ID of the account that owns this manifest

Response

201409

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

repoPath*string

totalDependencies*number

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "repoPath": "text",
  "totalDependencies": 0,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text"
}

Update a manifest catalog entity

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

Path parameters

id*string

ID of the catalog entity.

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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 associated with each user or team.

permissionsPatternsarray of string

generalAccessarray of enum

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

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

providerAccountIdstring

The key/ID of the account that owns this manifest

Response

200404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

repoPath*string

totalDependencies*number

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

Request

JavaScriptCurl

const response = await fetch('/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",
  "tags": [
    "text"
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "repoPath": "text",
  "totalDependencies": 0,
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text"
}

Create new team catalog entity.

POST/public/v1/catalog/entities/team

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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

Response

201400422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecost

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/team', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "tags": [
    "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-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Update team catalog entity.

PATCH/public/v1/catalog/entities/team/{id}

Path parameters

id*string

Entity id

Body

application/json

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

tagsarray of string

Tags to add to the entity, replaces the existing list

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

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.

permissionsPatternsarray of string

generalAccessarray of enum

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

Response

200400404422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecost

descriptionstring

Catalog entity description

tagsarray of string

Catalog entity's tags

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

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 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

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/entities/team/{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",
  "tags": [
    "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-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ]
}

Catalog Entity Relation

NB: create/delete relations between discovery created resources are forbidden

Labels possible values:

"belongs_to", "depends_on", "provides", "has_environment", "part_of", "owned_by", "consumes", "uses", "contains", "has_repository", "has_library", "has_manifest", "has_dependency", "child_of", "relative_to"

Possible entities relations:

service -> has_environment -> environment

service -> part_of -> system

service -> belongs_to -> application

team -> belongs_to -> person

service -> depends_on -> service

environment -> contains -> resource

resource -> uses -> resource

resource -> child_of -> resource

system -> depends_on -> system

application -> depends_on -> application

service -> has_repository -> repository

repository -> has_library -> library

repository -> has_manifest -> manifest

manifest -> has_dependency -> library

Create relation between catalog entities. NB: Resource-Resource relations are available only for non-discovery created resources.

POST/public/v1/catalog/relations

Body

application/json

serviceIdstring

Service id as an additional relation parameter. Used ONLY when creating Environment-Resource relation

sourceEntityId*string

Id of the entity from which we want to create a relation

targetEntityId*string

Id of the entity to which we want to create a relation

label*enum

Entity relation type

belongs_todepends_onprovideshas_environmentpart_ofowned_byconsumesusescontainshas_repositoryhas_libraryhas_manifesthas_dependencychild_ofrelative_to

Response

201400404422

Body

application/json

sourceEntityId*string

targetEntityId*string

label*enum

Entity relation type

belongs_todepends_onprovideshas_environmentpart_ofowned_byconsumesusescontainshas_repositoryhas_libraryhas_manifesthas_dependencychild_ofrelative_to

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/relations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceEntityId": "text",
      "targetEntityId": "text",
      "label": "belongs_to"
    }),
});
const data = await response.json();

Response

{
  "sourceEntityId": "text",
  "targetEntityId": "text",
  "label": "belongs_to"
}

GET a list of catalog relations.

GET/public/v1/catalog/relations

Query parameters

Response

200

Body

application/json

totalFound*number

Total elements found

pageNumber*number

pageSize*number

items*array of CatalogRelationDto (object)

Found catalog entities

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/relations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "items": [
    {
      "sourceEntityId": "text",
      "targetEntityId": "text",
      "label": "belongs_to"
    }
  ]
}

Delete catalog entity relation.

DELETE/public/v1/catalog/relations

Body

application/json

serviceIdstring

Catalog relation service id

sourceEntityId*string

Catalog Source entity id

targetEntityId*string

Catalog Target entity id

Response

200404422

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/relations', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceEntityId": "text",
      "targetEntityId": "text"
    }),
});
const data = await response.json();

Catalog Entity Metadata

Metadata type possible values:

"JSON", "Code", "Link", "Text", "AutoMap", "Nickname"

Get catalog entity's metadata id.

GET/public/v1/catalog/metadata/{id}

Path parameters

id*string

Unique id of catalog entity to return its metadata

Response

200400404

Body

application/json

id*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/metadata/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ]
}

Update catalog entity's metadata by id.

PUT/public/v1/catalog/metadata/{id}

Path parameters

id*string

Unique id of catalog entity to update its metadata

Body

application/json

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Response

200404422

Body

application/json

id*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteam

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/metadata/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON"
    }
  ]
}

Template

Template type possible values:

"core", "user"

Template entityType possible values:

"service"

Template category possible values:

"create", "display"

Get all the templates available.

GET/public/v1/templates

Query parameters

Response

200

Body

application/json

id*string

Template id

orgId*string

Template orgId

name*string

Template name

description*string

Template description

type*enum

Template type

coreuser

category*enum

Template category

createdisplay

iconstring

Template icon

definition*all of

Template definition

createdBy*string

Template createdBy

createdAt*string (date-time)

Template createdAt

updatedAt*string (date-time)

Template updatedAt

lastChangedBy*string

Template last changed by id

Request

JavaScriptCurl

const response = await fetch('/public/v1/templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "orgId": "text",
    "name": "text",
    "description": "text",
    "type": "core",
    "category": "create",
    "icon": "text",
    "definition": {
      "entityType": "application",
      "form": {
        "sections": [
          {
            "title": "text",
            "description": "text",
            "attributes": [
              {
                "name": "text",
                "description": "text",
                "displayName": "text",
                "attributeType": "string",
                "optional": false
              }
            ]
          }
        ]
      }
    },
    "createdBy": "text",
    "createdAt": "2024-04-28T18:31:45.246Z",
    "updatedAt": "2024-04-28T18:31:45.246Z",
    "lastChangedBy": "text"
  }
]

Scorecard

Trigger a reevaluate for the given scorecard

POST/public/v1/scorecards/{id}/run

Path parameters

id*string

Unique id of scorecard

Response

201404

Body

application/json

id*string

Schedule id

orgId*string

Schedule organization id

credentialId*string

Scorecard id

isActive*boolean

Schedule is active or not

createdBy*string

Schedule created by

createdDateTime*string (date-time)

Schedule created date time

lastChangedDateTime*string (date-time)

Schedule last changed by

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards/{id}/run', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "credentialId": "text",
  "isActive": false,
  "createdBy": "text",
  "createdDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z"
}

GET an organizational list of scorecard definitions optionally filtered.

GET/public/v1/scorecards

Query parameters

Response

200

Body

application/json

items*array of ScorecardDto (object)

totalFound*number

Total scorecards found

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum scorecards in one paginated response

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "name": "text",
      "description": "text",
      "icon": "activity",
      "metrics": [
        []
      ],
      "services": [
        []
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2024-04-28T18:31:45.246Z",
      "updatedAt": "2024-04-28T18:31:45.246Z",
      "notifications": [
        "DISCOVERY"
      ],
      "isEvaluating": false,
      "evaluatedAt": "2024-04-28T18:31:45.246Z",
      "evaluateTotal": 0,
      "evaluatePassed": 0,
      "evaluateFailed": 0,
      "evaluatePercentage": 0,
      "evaluateServicesPercentage": 0,
      "startAt": "2024-04-28T18:31:45.246Z",
      "dueAt": "2024-04-28T18:31:45.246Z",
      "generalAccess": [
        "read"
      ],
      "daysLeft": 0,
      "status": "ACTIVE"
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

GET an organizational scorecard definition by id.

GET/public/v1/scorecards/{id}

Path parameters

id*any

Id of scorecard definition to return

Response

200404422502

Body

application/json

id*string

Scorecard id

orgId*string

Scorecard organization id

name*string

Scorecard name

description*string

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

createdBy*string

Scorecard created by

lastChangedBy*string

Scorecard last changed by

createdAt*string (date-time)

Scorecard created at

updatedAt*string (date-time)

Scorecard updated at

notifications*array of enum

Scorecard notifications

isEvaluating*boolean

Scorecard is evaluating

evaluatedAt*string (date-time)

Scorecard evaluated at

evaluateTotal*number

Scorecard evaluate total

evaluatePassed*number

Scorecard evaluate passed

evaluateFailed*number

Scorecard evaluate failed

evaluatePercentage*number

Scorecard evaluate percentage

evaluateServicesPercentage*number

Scorecard evaluate services percentage

startAtnullable string (date-time)

Scorecard start at

dueAtnullable string (date-time)

Scorecard due at

generalAccess*array of enum

daysLeftnullable number

Scorecard valid days left

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

permissions*object

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "icon": "activity",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-04-28T18:31:45.246Z",
  "updatedAt": "2024-04-28T18:31:45.246Z",
  "notifications": [
    "DISCOVERY"
  ],
  "isEvaluating": false,
  "evaluatedAt": "2024-04-28T18:31:45.246Z",
  "evaluateTotal": 0,
  "evaluatePassed": 0,
  "evaluateFailed": 0,
  "evaluatePercentage": 0,
  "evaluateServicesPercentage": 0,
  "startAt": "2024-04-28T18:31:45.246Z",
  "dueAt": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "daysLeft": 0,
  "status": "ACTIVE"
}

Update an organizational scorecard definition by id.

PUT/public/v1/scorecards/{id}

Path parameters

id*string

Id of scorecard definition to update

Body

application/json

Scorecard metric object to be updated.

name*string

Scorecard name

descriptionstring

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

lastChangedBy*string

Scorecard last changed by

notificationsarray of enum

Scorecard notifications

startAtnullable string (date-time)

Scorecard start at

dueAtnullable string (date-time)

Scorecard due at

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

Response

200400404

Body

application/json

id*string

Scorecard id

orgId*string

Scorecard organization id

name*string

Scorecard name

description*string

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

createdBy*string

Scorecard created by

lastChangedBy*string

Scorecard last changed by

createdAt*string (date-time)

Scorecard created at

updatedAt*string (date-time)

Scorecard updated at

notifications*array of enum

Scorecard notifications

isEvaluating*boolean

Scorecard is evaluating

evaluatedAt*string (date-time)

Scorecard evaluated at

evaluateTotal*number

Scorecard evaluate total

evaluatePassed*number

Scorecard evaluate passed

evaluateFailed*number

Scorecard evaluate failed

evaluatePercentage*number

Scorecard evaluate percentage

evaluateServicesPercentage*number

Scorecard evaluate services percentage

startAtnullable string (date-time)

Scorecard start at

dueAtnullable string (date-time)

Scorecard due at

generalAccess*array of enum

daysLeftnullable number

Scorecard valid days left

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

permissions*object

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "icon": "activity",
      "metrics": [
        []
      ],
      "services": [
        []
      ],
      "lastChangedBy": "text",
      "status": "ACTIVE"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "icon": "activity",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-04-28T18:31:45.246Z",
  "updatedAt": "2024-04-28T18:31:45.246Z",
  "notifications": [
    "DISCOVERY"
  ],
  "isEvaluating": false,
  "evaluatedAt": "2024-04-28T18:31:45.246Z",
  "evaluateTotal": 0,
  "evaluatePassed": 0,
  "evaluateFailed": 0,
  "evaluatePercentage": 0,
  "evaluateServicesPercentage": 0,
  "startAt": "2024-04-28T18:31:45.246Z",
  "dueAt": "2024-04-28T18:31:45.246Z",
  "generalAccess": [
    "read"
  ],
  "daysLeft": 0,
  "status": "ACTIVE"
}

Get scorecard metrics

GET/public/v1/scorecards/{id}/metrics

Path parameters

id*string

Filter by scorecard service id

Query parameters

Response

200404

Body

application/json

items*array of ScorecardMetricDto (object)

List of scorecard metrics

totalFound*number

Total scorecard metrics found by this endpoint call

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum scorecard metrics in one paginated response

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards/{id}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "measurementId": "text",
      "name": "text",
      "description": "text",
      "comparisonOperator": "equal",
      "comparisonType": "number",
      "passOnNoData": false,
      "category": "SERVICE_METADATA",
      "icon": "issue-tracking",
      "notes": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2024-04-28T18:31:45.246Z",
      "updatedAt": "2024-04-28T18:31:45.246Z"
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 20
}

Get a scorecard results

GET/public/v1/scorecards/{id}/results

Path parameters

id*string

Unique id of scorecard

Query parameters

Response

200404

Body

application/json

orgId*string

The organization ID

metricId*string

The metric ID

serviceId*string

The service ID

scorecardId*string

The scorecard ID

comparisonOperator*enum

The comparison operator

equalless thanless than or equalgreater thangreater than or equalcontains texttext begins withtext ends withtext matches regexp

comparisonType*enum

The comparison type

numberversiontext

threshold*object

The threshold

rawResult*object

The raw result

pass*boolean

Is metric passed or not

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/public/v1/scorecards/{id}/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "orgId": "text",
    "metricId": "text",
    "serviceId": "text",
    "scorecardId": "text",
    "comparisonOperator": "equal",
    "comparisonType": "number",
    "pass": false,
    "updatedAt": "2024-04-28T18:31:45.246Z"
  }
]

Module settings (service plugins)

UI plugin names possible values:

"github_actions", "github_activity", "gitlab_pipelines", "gitlab_activity", "azure_devops_activity", "azure_devops_pipelines", "bitbucket_pipelines", "bitbucket_activity", "circle_ci", "datadog_embedded_dashboard", "datadog_embedded_graph", "datadog_monitor", "datadog_slo", "embedded_view", "jenkins", "jira_activity", "new_relic_chart", "opsgenie_oncall", "pagerduty_oncall", "scorecards", "sonarcloud_repo_profile"

Provider type possible values:

"REPOS", "CICD", "OTHER", "ISSUE_TRACKING", "OMS", "CODE_INSPECTION"

Provider name possible values:

"GitHub", "GitLab", "Azure DevOps", "Bitbucket", "CircleCI", "Datadog", "EmbeddedView", "Jenkins", "Jira", "NewRelic", "OpsGenie", "PagerDuty", "Scorecards", "SonarCloud"

Get a module setting by id.

GET/public/v1/module-settings/{id}

Path parameters

id*string

Id for given module setting.

Response

200404

Body

application/json

id*string

The unique identifier of the module setting

serviceId*string

The unique identifier of the service associated with the module setting

credentialId*string

The unique identifier of the credential associated with the module setting

providerName*enum

The name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

The type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

The unique identifier of the organization associated with the module setting

title*string

The title of the module setting

uiPluginName*enum

The name of the UI plugin associated with the module setting

github_actionsgithub_activitygitlab_pipelinesgitlab_activityazure_devops_activityazure_devops_pipelinesbitbucket_pipelinesbitbucket_activitycircle_cidatadog_embedded_dashboarddatadog_embedded_graphdatadog_monitordatadog_sloembedded_viewjenkinsjira_activitynew_relic_chartopsgenie_oncallpagerduty_oncallscorecardssonarcloud_repo_profile

configuration*array of ModuleSettingAspectDto (object)

An array of configuration aspects for the module setting

layout*all of

The layout of the module setting

status*enum

The status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

createdBy*string

The unique identifier of the user who created the module setting

lastChangedBy*string

The unique identifier of the user who last changed the module setting

createDateTime*string (date-time)

The date and time when the module setting was created

lastChangedDateTime*string (date-time)

The date and time when the module setting was last changed

state*array of ModuleSettingStateDto (object)

An array of state information associated with the module setting

Request

JavaScriptCurl

const response = await fetch('/public/v1/module-settings/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "title": "text",
  "uiPluginName": "github_actions",
  "configuration": [
    {
      "name": "text"
    }
  ],
  "layout": {
    "x": 0,
    "y": 0,
    "w": 0,
    "h": 0,
    "minW": 0,
    "maxW": 0,
    "minH": 0,
    "maxH": 0,
    "static": false,
    "isResizable": false,
    "isBounded": false
  },
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Create a module settings object.

POST/public/v1/module-settings

Body

application/json

Module settings object to be saved.

serviceId*string

Existing Service identifier

credentialId*string

Existing Credential identifier

providerName*enum

Provider name

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

Provider type

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

titlestring

Module title

uiPluginNameenum

Plugin name

github_actionsgithub_activitygitlab_pipelinesgitlab_activityazure_devops_activityazure_devops_pipelinesbitbucket_pipelinesbitbucket_activitycircle_cidatadog_embedded_dashboarddatadog_embedded_graphdatadog_monitordatadog_sloembedded_viewjenkinsjira_activitynew_relic_chartopsgenie_oncallpagerduty_oncallscorecardssonarcloud_repo_profile

configuration*array of ModuleSettingAspectDto (object)

Array of configuration aspects

layoutall of

The layout of the module setting

statearray of ModuleSettingStateDto (object)

Array of state information

status*enum

Status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

Response

201404

Body

application/json

id*string

The unique identifier of the module setting

serviceId*string

The unique identifier of the service associated with the module setting

credentialId*string

The unique identifier of the credential associated with the module setting

providerName*enum

The name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

The type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

The unique identifier of the organization associated with the module setting

title*string

The title of the module setting

uiPluginName*enum

The name of the UI plugin associated with the module setting

github_actionsgithub_activitygitlab_pipelinesgitlab_activityazure_devops_activityazure_devops_pipelinesbitbucket_pipelinesbitbucket_activitycircle_cidatadog_embedded_dashboarddatadog_embedded_graphdatadog_monitordatadog_sloembedded_viewjenkinsjira_activitynew_relic_chartopsgenie_oncallpagerduty_oncallscorecardssonarcloud_repo_profile

configuration*array of ModuleSettingAspectDto (object)

An array of configuration aspects for the module setting

layout*all of

The layout of the module setting

status*enum

The status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

createdBy*string

The unique identifier of the user who created the module setting

lastChangedBy*string

The unique identifier of the user who last changed the module setting

createDateTime*string (date-time)

The date and time when the module setting was created

lastChangedDateTime*string (date-time)

The date and time when the module setting was last changed

state*array of ModuleSettingStateDto (object)

An array of state information associated with the module setting

Request

JavaScriptCurl

const response = await fetch('/public/v1/module-settings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceId": "text",
      "credentialId": "text",
      "providerName": "GitHub",
      "providerType": "REPOS",
      "configuration": [
        {
          "name": "text"
        }
      ],
      "status": "ACTIVE"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "title": "text",
  "uiPluginName": "github_actions",
  "configuration": [
    {
      "name": "text"
    }
  ],
  "layout": {
    "x": 0,
    "y": 0,
    "w": 0,
    "h": 0,
    "minW": 0,
    "maxW": 0,
    "minH": 0,
    "maxH": 0,
    "static": false,
    "isResizable": false,
    "isBounded": false
  },
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Service dependencies

Get a diff of services and their dependencies based on the given input

POST/public/v1/sync/services/diff

Body

application/json

services*object

The list of service definitions, where the key is the name of the service

metatagMappingName*string

The metatag that will be used to map given services to existing ones with different names

Response

200

Body

application/json

services*Services (object)

dependencies*Dependencies (object)

errorsarray of string

A list of errors that happened during the sync

Request

JavaScriptCurl

const response = await fetch('/public/v1/sync/services/diff', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metatagMappingName": "text"
    }),
});
const data = await response.json();

Response

{
  "services": {
    "added": [
      "text"
    ]
  },
  "dependencies": {},
  "errors": [
    "text"
  ]
}

Apply a diff of services and their dependencies

POST/public/v1/sync/services

Body

application/json

services*all of

The list of service definitions, where the key is the name of the service

dependencies*all of

The list of service dependencies to be added/removed

metatagMappingName*string

The metatag that will be used to map given services to existing ones with different names

Response

200

Body

application/json

services*Services (object)

dependencies*Dependencies (object)

errorsarray of string

A list of errors that happened during the sync

Request

JavaScriptCurl

const response = await fetch('/public/v1/sync/services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "services": {
        "added": [
          "text"
        ]
      },
      "dependencies": {},
      "metatagMappingName": "text"
    }),
});
const data = await response.json();

Response

{
  "services": {
    "added": [
      "text"
    ]
  },
  "dependencies": {},
  "errors": [
    "text"
  ]
}

Deployments

Create a new deployment entity

POST/public/v1/deployments

Body

application/json

name*string

The name of deployment

descriptionstring

The description of deployment

repositoryId*string

The repository id in the Configure8 application

environment*string

The environment of deployment

status*enum

The status of deployment

PENDINGIN_PROGRESSFAILEDSUCCESSCANCELLEDOTHERUNKNOWNINACTIVEABANDONEDNOT_DEPLOYEDQUEUED

sha*string

The commit SHA hash of deployment

ref*string

The commit branch of deployment

url*string

The url on the web page with deployment details

startedAt*string (date-time)

The start date of deployment

versionstring

The version of deployment

loginstring

The login of deployment owner

ownerEmailstring

The email of deployment owner

finishedAtstring (date-time)

The finished date of deployment

Response

201400401403404500

Body

application/json

id*string

name*string

orgId*string

descriptionstring

Deployment entity description

status*enum

PENDINGIN_PROGRESSFAILEDSUCCESSCANCELLEDOTHERUNKNOWNINACTIVEABANDONEDNOT_DEPLOYEDQUEUED

repositoryId*string

The repository id

environmentIdstring

The environment id

originalEnvironmentstring

The original environment name

shastring

refstring

urlstring

The url on the web page with detail

versionstring

loginstring

ownerEmailstring

durationnumber

createdBy*string

lastChangedBy*string

createdAt*string (date-time)

updatedAtstring (date-time)

startedAt*string (date-time)

finishedAtnullable string (date-time)

Request

JavaScriptCurl

const response = await fetch('/public/v1/deployments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "repositoryId": "text",
      "environment": "text",
      "status": "PENDING",
      "sha": "text",
      "ref": "text",
      "url": "text",
      "startedAt": "2024-03-20T00:00:00.000Z"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "status": "PENDING",
  "repositoryId": "text",
  "environmentId": "text",
  "originalEnvironment": "text",
  "sha": "text",
  "ref": "text",
  "url": "text",
  "version": "text",
  "login": "text",
  "ownerEmail": "text",
  "duration": 0,
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-04-28T18:31:45.246Z",
  "updatedAt": "2024-04-28T18:31:45.246Z",
  "startedAt": "2024-04-28T18:31:45.246Z",
  "finishedAt": "2024-04-28T18:31:45.246Z"
}

Update a deployment entity

PATCH/public/v1/deployments/{id}

Path parameters

id*any

ID of the deployment entity.

Body

application/json

namestring

The name of deployment

descriptionstring

The description of deployment

statusenum

The status of deployment

PENDINGIN_PROGRESSFAILEDSUCCESSCANCELLEDOTHERUNKNOWNINACTIVEABANDONEDNOT_DEPLOYEDQUEUED

shastring

The commit SHA hash of deployment

urlstring

The url on the web page with deployment details

versionstring

The version of deployment

loginstring

The login of deployment owner

ownerEmailstring

The email of deployment owner

startedAtstring (date-time)

The start date of deployment

finishedAtstring (date-time)

The finished date of deployment

Response

200400401403404500

Body

application/json

id*string

name*string

orgId*string

descriptionstring

Deployment entity description

status*enum

PENDINGIN_PROGRESSFAILEDSUCCESSCANCELLEDOTHERUNKNOWNINACTIVEABANDONEDNOT_DEPLOYEDQUEUED

repositoryId*string

The repository id

environmentIdstring

The environment id

originalEnvironmentstring

The original environment name

shastring

refstring

urlstring

The url on the web page with detail

versionstring

loginstring

ownerEmailstring

durationnumber

createdBy*string

lastChangedBy*string

createdAt*string (date-time)

updatedAtstring (date-time)

startedAt*string (date-time)

finishedAtnullable string (date-time)

Request

JavaScriptCurl

const response = await fetch('/public/v1/deployments/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "status": "PENDING",
  "repositoryId": "text",
  "environmentId": "text",
  "originalEnvironment": "text",
  "sha": "text",
  "ref": "text",
  "url": "text",
  "version": "text",
  "login": "text",
  "ownerEmail": "text",
  "duration": 0,
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-04-28T18:31:45.246Z",
  "updatedAt": "2024-04-28T18:31:45.246Z",
  "startedAt": "2024-04-28T18:31:45.246Z",
  "finishedAt": "2024-04-28T18:31:45.246Z"
}

GET an organizational list of deployments optionally filtered.

GET/public/v1/deployments

Query parameters

Response

200400401403500

Body

application/json

items*array of array

totalFound*number

pageNumber*number

pageSize*number

aggregationobject

itemsarray of DeploymentDto (object)

Request

JavaScriptCurl

const response = await fetch('/public/v1/deployments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "description": "text",
      "status": "PENDING",
      "repositoryId": "text",
      "environmentId": "text",
      "originalEnvironment": "text",
      "sha": "text",
      "ref": "text",
      "url": "text",
      "version": "text",
      "login": "text",
      "ownerEmail": "text",
      "duration": 0,
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2024-04-28T18:31:45.246Z",
      "updatedAt": "2024-04-28T18:31:45.246Z",
      "startedAt": "2024-04-28T18:31:45.246Z",
      "finishedAt": "2024-04-28T18:31:45.246Z"
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

Delete a deployment entity

DELETE/public/v1/deployments/{id}

Path parameters

id*any

ID of the deployment entity.

Response

200400401403404500

Request

JavaScriptCurl

const response = await fetch('/public/v1/deployments/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

User

Return list of users based on the given filters

GET/public/v1/users

Query parameters

Response

200

Body

application/json

items*array of User (object)

List of users

totalFound*number

Total users found by this endpoint call

pageSize*number

Maximum users in one paginated response

pageNumber*number

Requested page, note that it starts with 0

Request

JavaScriptCurl

const response = await fetch('/public/v1/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {}
  ],
  "totalFound": 0,
  "pageSize": 0,
  "pageNumber": 0
}

Update a user entity

PATCH/public/v1/users/{id}

Path parameters

id*string

Unique id of user to update

Body

application/json

firstNamestring

User first name

lastNamestring

User last name

displayNamestring

User display name

photoUrlstring

User avatar url

statusenum

User status

INVITEDUNVERIFIEDACTIVEDISABLED

roleenum

User role

USERADMIN

Response

200404409

Body

application/json

id*string

User id

email*string

User email

orgId*string

User organization id

firstNamestring

User first name

lastNamestring

User last name

displayNamestring

User display name

status*enum

User status

INVITEDUNVERIFIEDACTIVEDISABLED

role*enum

User role

USERADMIN

photoUrlstring

User avatar url

acceptedTermsOfServiceAndPrivacyPolicyAtstring (date-time)

Identifier for when user accepted terms of service and privacy policy

lastChangedBystring

Who last changed this user info

lastLoginAtstring (date-time)

Last user login date

Request

JavaScriptCurl

const response = await fetch('/public/v1/users/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "status": "INVITED",
  "role": "USER",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2024-04-28T18:31:45.246Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2024-04-28T18:31:45.246Z"
}

Delete a user entity

DELETE/public/v1/users/{id}

Path parameters

id*string

Unique id of user to delete

Response

204404409

Request

JavaScriptCurl

const response = await fetch('/public/v1/users/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Batch API

NB: max batch size equals 50 elements

Batch create new resource catalog entities

POST/public/v1/catalog/batch/entities/resource

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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

providerResourceKey*string

The key/ID of the resource in the provider

provider*string

Provider name

providerResourceType*string

Provider resource type

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

parentsarray of EntityParentDto (object)

Catalog resource's parents

deepLinkUrlstring

Deep link to the resource

Response

200

Body

application/json

success*number

Number of successfully saved entities

failures*number

Number of entities that failed saving

items*array of CatalogResourceDto (object)

Created resources

failed*array of FailedResource (object)

Failed resources

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/batch/entities/resource', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "providerResourceKey": "text",
        "provider": "text",
        "providerResourceType": "text"
      }
    ]),
});
const data = await response.json();

Response

{
  "success": 0,
  "failures": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "tags": [
        "text"
      ],
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "label": "belongs_to"
        }
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-04-28T18:31:45.246Z",
      "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
      "provider": "text",
      "providerType": "text",
      "providerResourceKey": "text",
      "providerResourceType": "text",
      "providerAccountId": "text",
      "location": "text",
      "deepLinkUrl": "text"
    }
  ],
  "failed": [
    {
      "providerResourceKey": "text",
      "status": 0,
      "error": "text"
    }
  ]
}

Batch create new base catalog entities

POST/public/v1/catalog/batch/entities/base

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

tagsarray of string

Tags to add to 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

providerResourceType*string

Provider resource type

detailsobject

Resource details in json format

parentsarray of EntityParentDto (object)

Catalog resource's parents

Response

200

Body

application/json

success*number

Number of successfully saved entities

failures*number

Number of entities that failed saving

items*array of CatalogBaseDto (object)

Created base entities

failed*array of FailedBase (object)

Failed base entites

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/batch/entities/base', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "providerResourceType": "text"
      }
    ]),
});
const data = await response.json();

Response

{
  "success": 0,
  "failures": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "tags": [
        "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-04-28T18:31:45.246Z",
      "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
      "generalAccess": [
        "read"
      ],
      "providerResourceType": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "status": 0,
      "error": "text"
    }
  ]
}

Batch delete the specified catalog entities

DELETE/public/v1/catalog/batch/entities

Body

application/json

ids*array of string

Ids of entities to delete

Response

200

Body

application/json

deleted*number

Number of deleted entities

Request

JavaScriptCurl

const response = await fetch('/public/v1/catalog/batch/entities', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "deleted": 0
}

Credentials

GET a list of credentials

GET/public/v1/credentials

Query parameters

Response

200

Body

application/json

items*array of CredentialDto (object)

totalFound*number

Total credentials found

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum credentials in one paginated response

Request

JavaScriptCurl

const response = await fetch('/public/v1/credentials', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "providerName": "GitHub",
      "providerType": "REPOS",
      "orgId": "text",
      "configuration": [
        []
      ],
      "status": "ACTIVE",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-04-28T18:31:45.246Z",
      "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
      "createSchedule": false
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

POST a new credential

POST/public/v1/credentials

Body

application/json

Credential object to be created

name*string

Name of the credential

providerName*enum

Name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

Type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

configuration*array of CredentialAspectDto (object)

Configuration of the credential

statusenum

Status of the credential

ACTIVEDISABLEDBROKEN

Response

201400

Body

application/json

id*string

Credential id

name*string

Credential name

providerName*enum

Credential provider name

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

Credential provider type

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

Credential organization id

configuration*array of array

Credential configuration

status*enum

Credential status

ACTIVEDISABLEDBROKEN

createdBystring

Credential created by

lastChangedBystring

Credential last changed by

createDateTimestring (date-time)

Credential created at

lastChangedDateTimestring (date-time)

Credential updated at

createScheduleboolean

Credential updated at

Request

JavaScriptCurl

const response = await fetch('/public/v1/credentials', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "providerName": "GitHub",
      "providerType": "REPOS",
      "configuration": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "createSchedule": false
}

PUT a credential

PUT/public/v1/credentials/{id}

Path parameters

id*string

Body

application/json

Credential object to be updated

namestring

Name of the credential

configurationarray of string

Configuration of the credential

statusenum

Status of the credential

ACTIVEDISABLEDBROKEN

Response

200400

Body

application/json

id*string

Credential id

name*string

Credential name

providerName*enum

Credential provider name

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloud

providerType*enum

Credential provider type

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

Credential organization id

configuration*array of array

Credential configuration

status*enum

Credential status

ACTIVEDISABLEDBROKEN

createdBystring

Credential created by

lastChangedBystring

Credential last changed by

createDateTimestring (date-time)

Credential created at

lastChangedDateTimestring (date-time)

Credential updated at

createScheduleboolean

Credential updated at

Request

JavaScriptCurl

const response = await fetch('/public/v1/credentials/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-04-28T18:31:45.246Z",
  "lastChangedDateTime": "2024-04-28T18:31:45.246Z",
  "createSchedule": false
}

DELETE a credential

DELETE/public/v1/credentials/{id}

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/public/v1/credentials/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Query Builder

Query Builder API can be used to create complex queries and retrieve data from relations with multiple filtering layers. You can check the full documentation here.

Global search across catalog.

POST/public/v1/query-builder

Body

application/json

Filter properties

pageNumbernumber

Requested page, note that it starts with 0

pageSizenumber

Maximum entities in one paginated response

relationsarray of string

Relations to include

schemaIdentifier*string

Schema identifier to search against (Fetched from the UI)

filterarray of string

Filter properties

sortall of

Sort properties by field

startDatestring (date-time)

endDatestring (date-time)

Response

200400401403500

Body

application/json

items*array of array

Items found

totalFound*number

Total found items

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum entities in one paginated response

Request

JavaScriptCurl

const response = await fetch('/public/v1/query-builder', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "schemaIdentifier": "text"
    }),
});
const data = await response.json();

Response

{
  "items": [
    []
  ],
  "totalFound": 1000,
  "pageNumber": 0,
  "pageSize": 0
}

Global term aggregated search across C8 catalog.

POST/public/v1/query-builder/aggregated

Body

application/json

Aggregation properties

pageNumbernumber

Requested page, note that it starts with 0

pageSizenumber

Maximum entities in one paginated response

schemaIdentifier*string

Schema identifier to perform the aggregation on (Fetched from the UI)

aggregate*string

Aggregate to perform

relationsarray of string

Group by fields

filterarray of string

Filter properties

sortall of

Sort properties by field

startDatestring (date-time)

Start date for the query

endDatestring (date-time)

End date for the query

Response

200400401403500

Body

application/json

items*array of QueryBuilderAggregation (object)

Aggregated items

totalFound*number

Total found items

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum entities in one paginated response

Request

JavaScriptCurl

const response = await fetch('/public/v1/query-builder/aggregated', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "schemaIdentifier": "text",
      "aggregate": "count"
    }),
});
const data = await response.json();

Response

{
  "items": [
    {
      "count": 10
    }
  ],
  "totalFound": 1000,
  "pageNumber": 0,
  "pageSize": 0
}