Skip to main content

Create an entity

POST 

/v1/blueprints/:blueprint_identifier/entities

This route allows you to create an entity in your software catalog based on an existing blueprint in your data model. It can also be used to overwrite or update an existing entity.

To learn more about entities, check out the documentation.

Request

Path Parameters

    blueprint_identifier stringrequired

    Possible values: non-empty

    The identifier of the blueprint you want to create an entity from.

Query Parameters

    upsert boolean

    If true, this call will override the entire entity if it already exists.

    merge boolean

    If true and upsert is also true, this call will update the entity if it already exists.

    validation_only boolean

    If true, this call will only validate the entity and return the validation errors.

    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 created entity with a specific action run.

Body

    identifier

    object

    oneOf

    The identifier of the new entity.

    string

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

    title string

    The title of the new entity.

    icon string

    The icon of the new entity.

    team string, string[]

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

    properties object

    An object containing the properties of the new 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.

Responses

Successfully updated an entity

Loading...