How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Configure8 REST API

The Configure8 REST API gives platform teams programmatic access to the service catalog, scorecards, self-service actions, environments, and cost data. It is used to ingest services and resources from external systems, drive scorecards in CI, trigger self-service actions, and synchronize the portal with source-of-truth systems. The API is part of the Configure8 enterprise feature set alongside RBAC, SSO/SCIM, and audit logging.

Configure8 REST API is one of 6 APIs that Configure8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Catalog, REST, Scorecards, and Self-Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 71 operations across 51 paths, organized into 13 resource areas, and defines 120 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://app.configure8.io/public/v1.

71 operations 51 paths 120 schemas 9 DELETE21 GET15 PATCH21 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://app.configure8.io/public/v1
Authentication
API Key, HTTP Bearer
Resource Areas
13

Authentication & Security 2

Configure8 REST API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api-key). It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 71

Across 51 paths, the API surfaces 71 operations — 9 DELETE, 21 GET, 15 PATCH, 21 POST, 5 PUT. They span 13 resource areas, including Catalog Entity, Catalog Entity Batch, Catalog Relation, Catalog Entity Metadata, Templates, Users, Scorecard, Module Settings, and 5 more. Each is listed below with its method, path, parameters, and response codes.

Catalog Entity 23
POST
/public/v1/catalog/entities
Get catalog entities filtered by query.
CatalogEntityController_getCatalogEntities body → 200400
GET
/public/v1/catalog/entities/{id}
Get a catalog entity by id.
CatalogEntityController_getCatalogEntityById 1 param → 200404
DELETE
/public/v1/catalog/entities/{id}
Delete the specified catalog entity
CatalogEntityController_deleteCatalogEntityById 1 param → 200404409
POST
/public/v1/catalog/entities/person
Create a new person catalog entity
CatalogEntityController_createPersonEntity body → 201409
PATCH
/public/v1/catalog/entities/resource/{id}
Update a resource catalog entity
CatalogEntityController_updateResourceEntity 1 param body → 200404409422
PATCH
/public/v1/catalog/entities/service/{id}
Update a service catalog entity
CatalogEntityController_updateServiceEntity 1 param body → 200404409422
PATCH
/public/v1/catalog/entities/person/{id}
Update a person catalog entity
CatalogEntityController_updatePersonEntity 1 param body → 200404409
POST
/public/v1/catalog/entities/resource
Create a new resource catalog entity
CatalogEntityController_createCatalogResourceEntity body → 201409422
POST
/public/v1/catalog/entities/library
Create a new library catalog entity
CatalogEntityController_createCatalogLibrary body → 201409422
POST
/public/v1/catalog/entities/repository
Create an new repository catalog entity
CatalogEntityController_createCatalogRepository body → 201404409422
PATCH
/public/v1/catalog/entities/repository/{id}
Update a repository catalog entity
CatalogEntityController_updateRepositoryEntity 1 param body → 200404409422
POST
/public/v1/catalog/entities/environment
Create a new environment catalog entity
CatalogEntityController_createCatalogEnvironment body → 201404409422
POST
/public/v1/catalog/entities/service
Create a new service catalog entity
CatalogEntityController_createServiceEntity body → 201404409422
POST
/public/v1/catalog/entities/system
Create a new system catalog entity
CatalogEntityController_createCatalogSystemEntity body → 201409
POST
/public/v1/catalog/entities/application
Create a new application catalog entity
CatalogEntityController_createCatalogApplicationEntity body → 201409422
PATCH
/public/v1/catalog/entities/application/{id}
Update an application catalog entity
CatalogEntityController_updateApplicationEntity 1 param body → 200404409422
POST
/public/v1/catalog/entities/manifest
Create a new manifest catalog entity
CatalogEntityController_createCatalogManifestEntity body → 201409
PATCH
/public/v1/catalog/entities/environment/{id}
Update an environment catalog entity
CatalogEntityController_updateCatalogEnvironmentEntity 1 param body → 200404409422
PATCH
/public/v1/catalog/entities/manifest/{id}
Update a manifest catalog entity
CatalogEntityController_updateCatalogManifestEntity 1 param body → 200404409422
PATCH
/public/v1/catalog/entities/system/{id}
Update a system catalog entity
CatalogEntityController_updateCatalogSystemEntity 1 param body → 200404409
PATCH
/public/v1/catalog/entities/library/{id}
Update a library catalog entity
CatalogEntityController_updateCatalogLibraryEntity 1 param body → 200404409422
POST
/public/v1/catalog/entities/base
Create a new base catalog entity
CatalogEntityController_createCatalogBase body → 201400422500
PATCH
/public/v1/catalog/entities/base/{id}
Update a base catalog entity
CatalogEntityController_updateCatalogBaseEntity 1 param body → 200404409422500
Catalog Entity Batch 2
POST
/public/v1/catalog/batch/entities/resource
Batch create new resource catalog entities
CatalogEntityBatchController_createCatalogEntitiesBulk body → 200
DELETE
/public/v1/catalog/batch/entities
Batch delete the specified catalog entities
CatalogEntityBatchController_deleteCatalogEntitiesBulk body → 200
Catalog Relation 3
GET
/public/v1/catalog/relations
GET a list of catalog relations.
CatalogRelationController_getCatalogEntityRelations 4 params → 200
POST
/public/v1/catalog/relations
Create relation between catalog entities. NB: Resource-Resource relations are available only for non-discovery created resources.
CatalogRelationController_createCatalogEntityRelation body → 201400404422
DELETE
/public/v1/catalog/relations
Delete catalog entity relation.
CatalogRelationController_deleteCatalogRelationById body → 200404422
Catalog Entity Metadata 2
GET
/public/v1/catalog/metadata/{id}
Get catalog entity's metadata id.
CatalogEntityMetadataController_getCatalogEntityMetadataById 1 param → 200400404
PUT
/public/v1/catalog/metadata/{id}
Update catalog entity's metadata by id.
CatalogEntityMetadataController_updateCatalogEntityMetadataById 1 param body → 200404422
Templates 1
GET
/public/v1/templates
Get all the templates available.
TemplateController_getAllTemplates 4 params → 200
Users 3
PATCH
/public/v1/users/{id}
Update a user entity
UserController_updateUserById 1 param body → 200404409
DELETE
/public/v1/users/{id}
Delete a user entity
UserController_deleteUserById 1 param → 204404409
GET
/public/v1/users
Return list of users based on the given filters
UserController_getAllUsers 5 params → 200
Scorecard 6
POST
/public/v1/scorecards/{id}/run
Trigger a reevaluate for the given scorecard
ScorecardController_createScorecardSchedule 1 param → 201404
GET
/public/v1/scorecards
GET an organizational list of scorecard definitions optionally filtered.
ScorecardController_getScorecards 6 params → 200
GET
/public/v1/scorecards/{id}/metrics
Get scorecard metrics
ScorecardController_getMetricsByScorecardId 7 params → 200404
GET
/public/v1/scorecards/{id}/results
Get a scorecard results
ScorecardController_getScorecardMetricResults 4 params → 200404
PUT
/public/v1/scorecards/{id}
Update an organizational scorecard definition by id.
ScorecardController_updateScorecardById 1 param body → 200400404
GET
/public/v1/scorecards/{id}
GET an organizational scorecard definition by id.
ScorecardController_getScorecardDefinitionById 1 param → 200404422502
Module Settings 2
GET
/public/v1/module-settings/{id}
Get a module setting by id.
ModuleSettingsController_getModuleSettingById 1 param → 200404
POST
/public/v1/module-settings
Create a module settings object.
ModuleSettingsController_createModuleSetting body → 201404
Sync 2
POST
/public/v1/sync/services/diff
Get a diff of services and their dependencies based on the given input
SyncController_getServiceDiff body → 200
POST
/public/v1/sync/services
Apply a diff of services and their dependencies
SyncController_applyServiceDiff body → 200
Deployment 4
POST
/public/v1/deployments
Create a new deployment entity
DeploymentController_create body → 201400401403404500
GET
/public/v1/deployments
GET an organizational list of deployments optionally filtered.
DeploymentController_getDeployments 8 params → 200400401403500
PATCH
/public/v1/deployments/{id}
Update a deployment entity
DeploymentController_update 1 param body → 200400401403404500
DELETE
/public/v1/deployments/{id}
Delete a deployment entity
DeploymentController_delete 1 param → 200400401403404500
Credential 4
GET
/public/v1/credentials
GET a list of credentials
CredentialController_getCredentials 5 params → 200
POST
/public/v1/credentials
POST a new credential
CredentialController_createCredential body → 201400
PUT
/public/v1/credentials/{id}
PUT a credential
CredentialController_updateCredential 1 param body → 200400
DELETE
/public/v1/credentials/{id}
DELETE a credential
CredentialController_deleteCredential 1 param → 200
Private SCIM 3
PATCH
/api/v1/scim
Update SCIM config
ScimController_updateScimConfig body → 200
DELETE
/api/v1/scim
Delete SCIM config
ScimController_deleteScimConfig → 200
GET
/api/v1/scim
Get SCIM config for user's organization
ScimController_getScimConfig → 200
SCIM 16
GET
/public/v2/scim/Users/{id}
Get a SCIM user
SCIMController_getUser 1 param → 200401403404500
PUT
/public/v2/scim/Users/{id}
Update a SCIM user
SCIMController_putUser 1 param body → 200400401403404500
PATCH
/public/v2/scim/Users/{id}
Updates a SCIM user status
SCIMController_patchUser 1 param body → 204400401403404500
DELETE
/public/v2/scim/Users/{id}
Delete a SCIM user
SCIMController_deleteUser 1 param → 204400401403404500
GET
/public/v2/scim/Users
Get SCIM users
SCIMController_getUsers → 200401403500
POST
/public/v2/scim/Users
Create a SCIM user
SCIMController_createUser body → 201400401403409500
GET
/public/v2/scim/Groups
Get SCIM group list
SCIMController_getGroups → 200401403500
POST
/public/v2/scim/Groups
Create a SCIM group
SCIMController_createGroup body → 201400401403500
GET
/public/v2/scim/Groups/{id}
Get SCIM group
SCIMController_getGroup 1 param → 200401403404500
PUT
/public/v2/scim/Groups/{id}
Updates group membership or group name
SCIMController_putGroup 1 param body → 200400401403404500
PATCH
/public/v2/scim/Groups/{id}
Patch a SCIM group. Supports add, remove, and replace members or replace group name
SCIMController_patchGroup 1 param body → 204400401403404500
DELETE
/public/v2/scim/Groups/{id}
Delete a SCIM group
SCIMController_deleteGroup 1 param → 204400401403404500
GET
/public/v2/scim/ServiceProviderConfig
Get SCIM service provider configuration
SCIMController_getServiceProviderConfig → 200401403
GET
/public/v2/scim/ResourceTypes
Get SCIM ResourceTypes schema
SCIMController_getResourceTypes → 200401403
GET
/public/v2/scim/Schemas
Get array of all SCIM SCHEMAS
SCIMController_getSchemas → 200401403
GET
/public/v2/scim/Schemas/{schema}
Get SCIM schema by schema id
SCIMController_getSchema 1 param → 200401403

Schemas 120

The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are CatalogRepositoryDto (26 properties), ScorecardDto (26 properties), CatalogLibraryDto (23 properties), CatalogPersonDto (23 properties). Each schema is shown below with its type and property counts.

CatalogSimplePropertyFilter
object
3 properties 3 required
CatalogPropertyPublicFilter
object
2 properties 2 required
CatalogCompoundPropertyFilter
object
3 properties 3 required
CatalogEntitySort
object
2 properties 2 required
CatalogEntityQueryDto
object
8 properties
MetadataTagDto
object
4 properties 3 required
MetadataLinkDto
object
3 properties 3 required
EntityParentDto
object
4 properties 4 required
CatalogEntityDto
object
15 properties 4 required
CatalogEntitiesSearchResultDto
object
4 properties 4 required
CreateCatalogPersonDto
object
13 properties 2 required
UpdateCatalogResourceDto
object
14 properties
CatalogResourceDto
object
23 properties 10 required
UpdateCatalogServiceDto
object
12 properties
CatalogServiceDto
object
18 properties 4 required
UpdateCatalogPersonDto
object
11 properties
CatalogPersonDto
object
23 properties 6 required
CreateCatalogResourceDto
object
15 properties 4 required
CreateCatalogLibraryDto
object
12 properties 3 required
CatalogLibraryDto
object
23 properties 11 required
RepositoryContributorDto
object
3 properties 2 required
RepositoryLanguageDto
object
3 properties 3 required
RepositoryReleaseDto
object
4 properties 4 required
CreateCatalogRepositoryDto
object
15 properties 6 required
CatalogRepositoryDto
object
26 properties 14 required
UpdateCatalogRepositoryDto
object
16 properties 1 required
CreateCatalogEnvironmentDto
object
7 properties 1 required
CatalogEnvironmentDto
object
15 properties 4 required
CreateCatalogServiceDto
object
13 properties 1 required
CreateCatalogSystemDto
object
7 properties 1 required
CatalogSystemDto
object
15 properties 4 required
CreateCatalogApplicationDto
object
7 properties 1 required
CatalogApplicationDto
object
15 properties 4 required
UpdateCatalogApplicationDto
object
8 properties
CreateCatalogManifestDto
object
12 properties 5 required
CatalogManifestDto
object
22 properties 11 required
UpdateCatalogEnvironmentDto
object
8 properties
UpdateCatalogManifestDto
object
13 properties
UpdateCatalogSystemDto
object
8 properties
UpdateCatalogLibraryDto
object
13 properties 1 required
CreateCatalogBaseDto
object
10 properties 2 required
CatalogBaseDto
object
17 properties 5 required
UpdateCatalogBaseDto
object
10 properties
FailedResource
object
3 properties 3 required
CreateCatalogResourceBatchResultDto
object
4 properties 4 required
DeleteCatalogEntitiesBatchDto
object
1 property 1 required
DeleteCatalogEntitiesBatchResultDto
object
1 property 1 required
CatalogRelationDto
object
4 properties 3 required
CatalogRelationResultDto
object
4 properties 4 required
CreateCatalogRelationDto
object
5 properties 3 required
DeleteCatalogRelationDto
object
4 properties 2 required
CatalogEntityMetadataDto
object
4 properties 3 required
CatalogEntityMetadataUpdateDto
object
1 property
TemplateAttributeDto
object
5 properties 4 required
TemplateFormSectionDto
object
3 properties 3 required
TemplateFormDto
object
1 property 1 required
TemplateDefinitionDto
object
2 properties 2 required
TemplateDto
object
12 properties 11 required
UpdateUserDto
object
6 properties
UserDto
object
13 properties 5 required
User
object
UsersPageDto
object
4 properties 4 required
ScheduleDto
object
7 properties 7 required
ScorecardDto
object
26 properties 23 required
ScorecardPageDto
object
4 properties 4 required
ScorecardMetricDto
object
17 properties 11 required
ScorecardMetricPageDto
object
4 properties 4 required
ScorecardMetricResultDto
object
10 properties 10 required
UpdateScorecardDefinitionDto
object
10 properties 6 required
ModuleSettingAspectDto
object
2 properties 2 required
ModuleSettingLayoutDto
object
11 properties 4 required
ModuleSettingStateDto
object
2 properties 2 required
ModuleSettingsDto
object
16 properties 16 required
CreateModuleSettingsDto
object
10 properties 5 required
ServiceDefinition
object
1 property 1 required
GetServiceDiffDto
object
2 properties 2 required
Services
object
2 properties 2 required
Dependencies
object
2 properties 2 required
SyncServicesResultDto
object
3 properties 2 required
ApplyServiceDiffDto
object
3 properties 3 required
CreateDeploymentDto
object
13 properties 8 required
DeploymentDto
object
21 properties 9 required
UpdateDeploymentDto
object
10 properties
PaginatedResponseDto
object
5 properties 4 required
CredentialDto
object
12 properties 7 required
CredentialPageDto
object
4 properties 4 required
CredentialAspectDto
object
2 properties 2 required
CreateCredentialDto
object
5 properties 4 required
UpdateCredentialDto
object
3 properties
UpdateScimConfigDto
object
1 property 1 required
ScimConfigDto
object
4 properties 4 required
SCIMUserNameDto
object
2 properties 2 required
SCIMUserEmailDto
object
3 properties 3 required
SCIMUserGroupDto
object
2 properties 2 required
SCIMUserMetaDto
object
4 properties 1 required
SCIMUserDto
object
10 properties 10 required
SCIMErrorDto
object
3 properties 3 required
SCIMUserListDto
object
5 properties 5 required
SCIMCreateUserDto
object
8 properties 8 required
SCIMUserPatchBodyDto
object
2 properties 2 required
SCIMGroupMemberDto
object
3 properties 3 required
SCIMGroupMetaDto
object
2 properties 2 required
SCIMGroupDto
object
5 properties 5 required
SCIMGroupListDto
object
5 properties 5 required
SCIMGroupCreateDto
object
3 properties 3 required
SCIMGroupUpdateDto
object
4 properties 4 required
SCIMGroupPatchBodyDto
object
2 properties 2 required
SCIMSchemaPatchDto
object
1 property 1 required
SCIMSchemaBulk
object
3 properties 3 required
SCIMSchemaFilterDto
object
2 properties 2 required
SCIMSchemaChangePassword
object
1 property 1 required
SCIMSchemaSortDto
object
1 property 1 required
SCIMSchemaEtagDto
object
1 property 1 required
SCIMSchemaAuthenticationSchemaDto
object
5 properties 5 required
SCIMSchemaMetaDto
object
5 properties
ScimSchemaServiceProviderConfigDto
object
10 properties 10 required
ScimResourceTypeDto
object
8 properties 8 required
ScimSchemaUserDto
object
10 properties 8 required
SCIMSchemaMemberDto
object
3 properties 3 required
ScimSchemaGroupDto
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

configure8-c8-public-api-openapi.json Raw ↑

Other APIs Configure8 publishes across the network.

Configure8 Catalog Entities API
Configure8 Catalog Relations API
Configure8 Deployments API
Configure8 Scorecards API
Configure8 Users API
Where this information came from

This is an independent, third-party profile of Configure8 REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.