Skip to main content

Change a blueprint

PUT 

/v1/blueprints/:identifier

This route allows you to change a specific blueprint in your Port account.

To learn more about blueprints, check out the documentation.

Request

Path Parameters

    identifier stringrequired

    The identifier of the blueprint you want to change.

Body

required

    identifier string

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

    The new identifier of the blueprint.

    title stringrequired

    Possible values: <= 30 characters

    The new title of the blueprint.

    description string

    Possible values: <= 200 characters

    The new description of the blueprint.

    icon string

    The new icon of the blueprint.

    teamInheritance

    object

    A new relation to another blueprint from which to inherit the team. Can be any blueprint connected to this one via any number of relations. path is the path to the desired blueprint via relations, for example: "relationIdentifier.relationIdentifierInRelatedBlueprint"

    path stringrequired

    schema

    object

    required

    The new schema of the blueprint, see properties and required below for more information.

    properties

    object

    required

    The new properties of the blueprint.

    property name*

    object

    title string
    description string
    icon string
    type required

    Possible values: [string, number, boolean, object, array]

    format

    Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, timer, proto]

    spec

    Possible values: [open-api, embedded-url, async-api]

    required string[]

    The new required properties of the blueprint, these must be provided when creating an entity based on this blueprint. This is an array of the required properties' identifiers.

    calculationProperties

    object

    The new calculation properties of the blueprint.

    property name*

    object

    title string
    description string
    icon string
    calculation stringrequired
    type required

    Possible values: [string, number, boolean, object, array]

    format

    Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, proto]

    spec

    Possible values: [open-api, embedded-url, async-api]

    colorized boolean
    colors object

    items

    object

    type

    Possible values: [string, number, boolean, object, array]

    format

    Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, timer, proto]

    mirrorProperties

    object

    The new mirror properties of the blueprint.

    property name*

    object

    path stringrequired

    Possible values: Value must match regular expression ^(?:[A-Za-z0-9@_=\-]+\.)+?(\w|\$|@|-)*?[^\.]+$

    title string

    aggregationProperties

    object

    The new aggregation properties of the blueprint.

    property name*

    object

    title stringrequired
    description string
    icon string
    type

    Possible values: [number]

    Default value: number

    target stringrequired

    calculationSpec

    object

    required

    The calculation specification of the aggregation property. For more information and examples, see the documentation.

    query

    object

    combinator required

    Possible values: [and, or]

    rules

    object[]

    required

  • Array [

  • anyOf

    property stringrequired
    operator required

    Possible values: [>, >=, <, <=]

    value numberrequired
  • ]

  • relations

    object

    The new relations of the blueprint.

    property name*

    object

    title string
    target stringrequired
    required booleanrequired
    many booleanrequired
    description string

    changelogDestination

    object

    The destination of the blueprint's changelog.

    oneOf

    type stringrequired

    Possible values: [WEBHOOK]

    agent boolean

    If true, Port's execution agent will be used to send the changelog.

    url urirequired

    The URL of the webhook.

Responses

Default Response

Loading...