Skip to main content

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

Path Parameters

    entity_identifier stringrequired

    Possible values: non-empty

    The identifier of the entity you want to change.

    blueprint_identifier stringrequired

    Possible values: non-empty

    The identifier of the blueprint the entity belongs to.

Query Parameters

    create_missing_related_entities boolean

    If true, this call will also create missing related entities.
    This is useful when you want to create an entity and its related entities in one call, or if you want to create an entity whose related entity does not exist yet.

    run_id string

    You can provide a run_id to associate the modified entity with a specific action run.

Body

    identifier

    object

    oneOf

    The new identifier of the entity.

    string

    Possible values: Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$

    title string

    The new title of the entity.

    icon string

    The new icon of the entity.

    team string, string[]

    The Port team/s to which the entity will belong.

    properties object

    An object containing the properties of the entity, in "key":"value" pairs where the key is the property's identifier, and the value is its value.

    relations object

    An object containing the relations of the new entity, in "key":"value" pairs where the key is the relation's identifier, and the value is the related entity's identifier.

Responses

Successfully changed the entity

Loading...