Skip to main content

Check out Port for yourself

Change an entity

PUT /v1/blueprints/:blueprint_identifier/entities/:entity_identifier

This route allows you to edit a specific entity in your software catalog and update its properties.

To learn more about entities, check out the documentation.

Request

Responses

Successfully changed the entity.
The response will have the following structure:

{
  "ok": true,
  "entity": {
    "identifier": "new-microservice",
    "title": "MyNewMicroservice",
    "icon": "Microservice",
    "team": [],
    "properties": {
      "content": "my content"
    },
    "relations": {}
  }
}

Key	Type
identifier	string
title	string
icon	string
team	string[]
properties	object
relations	object

One of the following errors occurred:

Error	Description
required_relation	Relation cannot be deleted because it is a required relation
missing_permissions	You do not have permissions to perform the requested operation. For further details, please contact your admin

One of the following errors occurred:

Error	Description
invalid_request	The provided data does not match the route schema
team_inheritance_enabled	The blueprint's entities inherite their team from other entities through an existing relation
blueprint_schema_mismatch	The provided entity does not match the blueprint's schema
required_relation	A relation is required
relation_many_violation	A provided relation cannot contain more than one entity