Service

• Create a service entity

• Update service entity

• Apply diff of two service

• Get diff of two services

Service

Create a new service catalog entity

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

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

permissionsobject

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

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents

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

201401403404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

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

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T12:14:21.110Z",
  "lastChangedDateTime": "2024-12-21T12:14:21.110Z",
  "generalAccess": [
    "read"
  ],
  "repositoryPath": "text",
  "languages": [
    "text"
  ],
  "lifecycle": "text"
}

Update a service catalog entity

PATCHhttps://app.configure8.io/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

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

parentsarray of EntityParentDto (object)

Catalog entity's parents, replaces the existing parents list

replaceMetadataTagsboolean

Replace metadata tags with the provided list

repositoryPathstring

The path of the repository

languagesarray of string

The languages that this service uses

lifecyclestring

The lifecycle of the service

templateIdstring

The ID of the template that this service is based on

Response

200401403404409422

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerabilityaws_security_hub_finding

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

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

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T12:14:21.110Z",
  "lastChangedDateTime": "2024-12-21T12:14:21.110Z",
  "generalAccess": [
    "read"
  ],
  "repositoryPath": "text",
  "languages": [
    "text"
  ],
  "lifecycle": "text"
}

Apply a diff of services and their dependencies

POSThttps://app.configure8.io/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

200401403

Body

application/json

services*Services (object)

dependencies*Dependencies (object)

errorsarray of string

A list of errors that happened during the sync

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/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

200

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

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

POSThttps://app.configure8.io/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

200401403

Body

application/json

services*Services (object)

dependencies*Dependencies (object)

errorsarray of string

A list of errors that happened during the sync

Request

JavaScriptCurlPython

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

Response

200

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