Put Structurizr Diagrams from Repository

If you already have Structurizr Diagrams written using Structurizr DSL in your Repository, you can put them directly to Pistacy.io using our API. Following page describes how to put ADR documents using API.

Configure Workspace first

By default, you don't have configured Structurizr Workspace in Pistacy.io Organization. You have to configure it first to be able to put diagrams using this API. To configure it, go to Pistacy.io Structurizr page and click "Configure it now!".

Put diagram

Structurizr Document you are about to put has to be written using Structurizr DSL format.

Basic request to API states as follows. Notice that you need to replace:

  • {PROJECT-ID} - Project ID which document shoud be placed to, inside the Organization.
  • {API-KEY} - Organization API Key.
curl --location --request PUT 'https://app.pistacy.io/org-api/v1/structurizr/diagrams/external'
--header 'Accept: application/json, text/plain, */*'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {API-KEY}'
--header 'X-Project-ID: {PROJECT-ID}'
--data '{
    "dsl": "workspace \"Workspace\" {\n}"
}'

Use Pistacy.io in your project today!

Try Pistacy.io platform - it is free of charge!

It's free - Try it!