Service

PreviousResource NextTeam

Last updated 2 months ago

Update a service catalog entity

patch

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

Path parameters

idstringrequired

Unique id of catalog entity to update

Body

namestring

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

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

replaceMetadataTagsboolean

Replace metadata tags with the provided list

repositoryPathstring

The path of the repository

lifecyclestring

The lifecycle of the service

templateIdstring

The ID of the template that this service is based on

linksobject[]

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

metaTagsobject[]

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

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

languagesstring[]

The languages that this service uses

generalAccessstring · enum[]

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

permissionsobject

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

409

422

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:02:50.304Z",
  "lastChangedDateTime": "2025-02-21T18:02:50.304Z",
  "repositoryPath": "text",
  "lifecycle": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "languages": [
    "text"
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Create a new service catalog entity

post

/public/v1/catalog/entities/service

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

repositoryIdstring

The ID of the repository entity to assign to the service

repositoryPathstring

The path of the repository

lifecyclestring

The lifecycle of the service

templateIdstring

The ID of the template that this entity is based on

linksobject[]

List of URLs linked to this entity

metaTagsobject[]

List of metadata tags linked to this entity

parentsobject[]

Catalog entity's parents

languagesstring[]

The languages that this service uses

applicationsstring[]

The ID of the application entities linked to this service

generalAccessstring · enum[]

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

permissionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

401

403

404

409

422

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:02:50.304Z",
  "lastChangedDateTime": "2025-02-21T18:02:50.304Z",
  "repositoryPath": "text",
  "lifecycle": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "languages": [
    "text"
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Apply a diff of services and their dependencies

post

/public/v1/sync/services

Body

metatagMappingNamestringrequired

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

servicesall ofrequired

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

dependenciesall ofrequired

The list of service dependencies to be added/removed

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/sync/services' \
  --header 'Content-Type: application/json' \
  --data '{"metatagMappingName":"text","services":{"added":[null],"mappings":{}},"dependencies":{"added":{"ANY_ADDITIONAL_PROPERTY":[null]},"removed":{"ANY_ADDITIONAL_PROPERTY":[null]}}}'

200

401

403

{
  "services": {
    "added": [
      "text"
    ],
    "mappings": {}
  },
  "dependencies": {
    "added": {
      "ANY_ADDITIONAL_PROPERTY": [
        null
      ]
    },
    "removed": {
      "ANY_ADDITIONAL_PROPERTY": [
        null
      ]
    }
  },
  "errors": [
    "text"
  ]
}

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

post

/public/v1/sync/services/diff

Body

metatagMappingNamestringrequired

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

servicesobjectrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/sync/services/diff' \
  --header 'Content-Type: application/json' \
  --data '{"metatagMappingName":"text","services":{"ANY_ADDITIONAL_PROPERTY":{"calls":[null]}}}'

200

401

403

{
  "services": {
    "added": [
      "text"
    ],
    "mappings": {}
  },
  "dependencies": {
    "added": {
      "ANY_ADDITIONAL_PROPERTY": [
        null
      ]
    },
    "removed": {
      "ANY_ADDITIONAL_PROPERTY": [
        null
      ]
    }
  },
  "errors": [
    "text"
  ]
}