Skip to main content

Check out Port for yourself 

Patch an entity

PATCH 
/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 patch.

    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.

    Default value: false
    run_id string

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

Body

    identifierstring

    The new identifier of the entity.

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

    titlestring

    The new title of the entity.

    iconstring

    The new icon of the entity.

    teamstring, string[]

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

    propertiesobject

    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.
    You can also use a search query to define relations based on a property of the related entity.

    property name*

    object

    anyOf

    string

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

Responses​

Successfully patched the entity

Last updated on