Skip to content

Commit

Permalink
Merge branch 'PORT-11635-bug-fix-mapping-configuration-in-new-relic-c…
Browse files Browse the repository at this point in the history
…loud-ingesting' of https://github.com/port-labs/port-docs into PORT-11635-bug-fix-mapping-configuration-in-new-relic-cloud-ingesting
  • Loading branch information
shariff-6 committed Dec 2, 2024
2 parents 1fa7a01 + cd40151 commit b5a3c72
Show file tree
Hide file tree
Showing 63 changed files with 5,626 additions and 4,580 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,22 @@ This page will teach you how to use Port's API to obtain existing action runs an

## Where to find your action runs

You can find your existing/finished action runs using one of the following methods:
### Non-admin roles

`Members` and `moderators` can find their existing/finished action runs using one of the following methods:

- The `My latest runs` list - click on the <img src="/img/self-service-actions/reflect-action-progress/auditLogButton.svg" style={{"vertical-align": "text-top"}} className="not-zoom" /> button in the top-right corner of the page.

This will display the latest action runs that have been executed by the logged-in user:
<img src='/img/self-service-actions/reflect-action-progress/myLatestRuns.png' width='35%' border='1px' />

You can also click on the `My run history` button to see a table with all of the user's previous action runs.

- After executing an action from the [self-service page](https://app.getport.io/self-serve), the `My latest runs` list will open automatically, showing the newly created action run.

### Admin role

In addition to the methods mentioned above, `admins` can find action runs using one of the following methods:

- The dedicated `Runs history` table:
- **Self-service actions** - go to the [self-service page](https://app.getport.io/self-serve) of your portal, then click on the <img src="/img/self-service-actions/reflect-action-progress/auditLogButton.svg" style={{"vertical-align": "text-top"}} className="not-zoom" /> button in the top-right corner.
Expand All @@ -22,10 +37,6 @@ You can find your existing/finished action runs using one of the following metho
- Go the [entity page](/customize-pages-dashboards-and-plugins/page/entity-page.md) of your desired entity, then select the `Runs` tab.
This page will display all action runs that have been executed for the selected Entity.

- Once you have at least one `in-progress` action run, a panel will be displayed on the right side of the page, showing the runs that are currently in progress.

- After executing an action from the [self-service page](https://app.getport.io/self-serve), a toast will appear in the bottom-right of the page, with a link to the newly created action run.

## Interacting with action runs

Once an `actionRun` is created, it will have a unique `runId`. Using this id, you can interact with the action run using Port's API.
Expand Down
48 changes: 35 additions & 13 deletions static/apispec.yaml → docs/api-reference/apispec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16364,17 +16364,17 @@ paths:
responses:
"200":
description: Default Response
'/v1/organization/secrets':
/v1/organization/secrets:
get:
description: This route allows you to retrieve all of the secrets in your organization.<br/><br/>To learn more about secrets management in Port, check out the [documentation](https://docs.getport.io/sso-rbac/port-secrets).
summary: Get all organization secrets
tags:
- Organization
security:
- bearer:
- 'read:blueprints'
- read:secrets
responses:
'200':
"200":
description: Default Response
post:
summary: Create an organization secret
Expand All @@ -16387,23 +16387,41 @@ paths:
schema:
type: object
properties:
secret_name:
secretName:
type: string
description: The name of the new secret.<br/>
secret_value:
maxLength: 50
minLength: 1
pattern: ^[A-Za-z0-9-_]*$
secretValue:
type: string
description: The value of the new secret.<br/>
description:
type: string
description: An optional description of the new secret.<br/>
maxLength: 200
additionalProperties: false
required:
- secret_name
- secret_value
- secretName
- secretValue
required: true
security:
- bearer: [ ]
- bearer:
- create:secrets
responses:
'200':
"200":
description: Default Response
"/v1/organization/secrets/{secret_name}":
get:
summary: Get an organization secret
description: This route allows you to retrieve a specific secret in your organization.<br/><br/>To learn more about secrets management in Port, check out the [documentation](https://docs.getport.io/sso-rbac/port-secrets).
tags:
- Organization
security:
- bearer:
- read:secrets
responses:
"200":
description: Default Response
patch:
summary: Patch an organization secret
Expand All @@ -16421,8 +16439,10 @@ paths:
description: The new value of the secret.<br/>
description:
type: string
maxLength: 200
description: The new description of the secret.<br/>
additionalProperties: false
required: []
parameters:
- schema:
type: string
Expand All @@ -16431,9 +16451,10 @@ paths:
required: true
description: The name of the secret you want to patch.<br/>
security:
- bearer: []
- bearer:
- update:secrets
responses:
'200':
"200":
description: Default Response
delete:
summary: Delete an organization secret
Expand All @@ -16448,9 +16469,10 @@ paths:
required: true
description: The name of the secret you want to delete.<br/>
security:
- bearer: [ ]
- bearer:
- delete:secrets
responses:
'200':
"200":
description: Default Response
/v1/apps:
get:
Expand Down
17 changes: 8 additions & 9 deletions docs/api-reference/create-an-organization-secret.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: "This route allows you to create an organization secret.<br/><br/>T
sidebar_label: "Create an organization secret"
hide_title: true
hide_table_of_contents: true
api: eJzdVMtu2zAQ/BWCpxZwrKRHIwiQPg5FDwkS9+QaxUreWEwkkuXDiSvo37tLSbbsPNpzEUChydnl7swsG7lCXzhlgzJazuS8VF44EwMKqCrz6MXWRBGMKBwCb2ph3Bq0+g0cITzSQZie5y67SJ+5ERWC06I2juA5pepBXtSgYY016iCUFtfGhYkoSiweBKNCiWKxMkVkQMq+fFeGYP0sy2jbT9cYLMVMlcm8NycuhyLjjZM+//upnMgAay9nC3k1qlIuJ9Lhr4g+fDSrrZw1sjA60DW8BGsrVSRgdu+ZhUZ6KqsGXoWtReLF5PdYBMpvnbHogkKfcOnmnxpqHIF9cEqvCXzMLQpGCnOXmtX4eMCfbCdDwg1U8R8zJuhbKQ9C/pbxkvRNa6jE6OT1/G1HrXK4YtrHhBx1s2wPwcFF7DqOTgVSZdHInKyDjpbLNmnmrdG+o/rD6Sn/Oyz3M95BrIK46ZGpnhpDaegCaY1PkkEo6Ve2OcvG3s1626Q63QadTyVEVxF4MB5YNfId0fkSIPoDzHLf1C37qKt/aG2nAEV+wy3d3rlHXkYq2w2WnUjFDZYIK4rittibN3sXf3mC2lb4zIV7ZQ+99Jri/XbLF96ZVJ8KnFfygIrL668Uwux08LPpKWOZWhpnhvfXfnrrgTi+dTSA/8GT0+kZ8ClktgLSjQhKLml67y3k5oyA4zZ2+nh+nUp2KsGaJgeP313VtrxNYjseDFpuwCnIWReajcngCzbsA5mI6O/4PJlzMQzvRH/2uLE7dwNyfXU7J3DeP4q1WXGMg0fa5O9M/qA/rjzplnyc9htZgV5HopYwXV62KETuduzwh+TwfsHVDkd6O6ry2PpdS/zlgXsx5JyMKWh+Lnbw7uTVgJ6xAc0q8Yv0B1Hqb4Y=
api: eJzdVE2P0zAQ/SvWiAMgt2lX4kCEkMrHAYHYaikcqAqaJtPGu4mdtZ3udqP8dzRO2qbdXdgzF9d1nsfvzbyZGlJyiVWlV0ZDDLNMOWFN5UlgnpsbJ7amEt6IxBLyoRbGrlGrO+QbwlFiyQ/fLG30NiwzI3JCq0VhLAlcmsp3ICcK1LimgrQXSoupsV6KJKPkSjDKZyTmqUkqBoToi+eZ96WLoyg1iRuuyZfG+qEykXNmYJeYRHww6OK/GIIEj2sH8RzOeyxhIcHSdUXOvzPpFuIaEqM9ac9bLMtcJQEYXTrOQg0uyahA3vltSRCDWV5S4kFCaU1J1ityARde/ooF9bDOW6XXIO+lloTGgoRZBa2abo7SBxIKvP1Ceu0ziF+NJBRK7/6OJZToPVmO9Gs+GfzEwd1o8Hrwe/HyGTSyY/ID8+qJVDYMfZRLc3LlXxEnWpiwx1z0vjxN69lo1DQSME1VG2LaS/IKc0dt/ZSllGvby/qx8EXDcQ5Qbytqc1NZ5bcQz2tYElqyHKa1dNy5BxZNsIkrjXZtdc9GI/45VvqBVljlXlx0SOAnC/KZSSGG0rjgEmRdEG3GUb9dot1bzMluyLpAqbI5xLDzOpaqZ3Vo5EOAyh1hFgeR39i6Lf+d1H3xsFSfaQsSdHAsTCqfGbvrEgmKBWaEKdkgi9vh4tA4H2+xKHM6Nf7BE0cmfMwq3XHDz61MYKc8RwWeCGIy/QQSODctfDwcMZYTW2BwYkf+/d8m0umrvY7/D2ZcW01Ptz4qc1SaExQ8UnfOm8NmDBL6MvblcTwOM/ZpPIe6XqKj7zZvGj6+rshymywkbNAqXHJd5otG7lzBdr2iLae/zedgxmQY3hb93jRlb+7bY3r+bQYSlt0ULkzKdyzegAxrDMw61Cw4OJzVkKNeV7hmbBszjIuKlfa9fRW83W2Y6e6T3vYYnpq+lcMrt9qDV+q67Zym2ePbT4/e6NK1Q3OJeDj9ATqxlIo=
sidebar_class_name: "post api-method"
info_path: api-reference/port-api
info_path: api-reference-temp/port-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand Down Expand Up @@ -86,16 +85,16 @@ This route allows you to create an organization secret.<br/><br/>To learn more a
>
<SchemaItem
collapsible={false}
name={"secret_name"}
name={"secretName"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"The name of the new secret.<br/>"}}
qualifierMessage={"**Possible values:** `non-empty` and `<= 50 characters`, Value must match regular expression `^[A-Za-z0-9-_]*$`"}
schema={{"type":"string","description":"The name of the new secret.<br/>","maxLength":50,"minLength":1,"pattern":"^[A-Za-z0-9-_]*$"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"secret_value"}
name={"secretValue"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
Expand All @@ -107,8 +106,8 @@ This route allows you to create an organization secret.<br/><br/>To learn more a
name={"description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"An optional description of the new secret.<br/>"}}
qualifierMessage={"**Possible values:** `<= 200 characters`"}
schema={{"type":"string","description":"An optional description of the new secret.<br/>","maxLength":200}}
>

</SchemaItem>
Expand Down
7 changes: 3 additions & 4 deletions docs/api-reference/delete-an-organization-secret.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: "This route allows you to delete an organization secret.<br/><br/>T
sidebar_label: "Delete an organization secret"
hide_title: true
hide_table_of_contents: true
api: eJzdU01r20AQ/SvLnBJQLLtHEQIB+1BaaEjdkzFlLY2txfKush9OXaH/3pmVlMquU+i1F2k/3uzMe/OmgQJdblXtldGQwbJUTlgTPApZVebViZMJwhtRYIV8qIWxO6nVT8kRwmFu0U/uNzZ9iJ+lERVKq8XBWIJv6Kke5MRBarnDA2ovlBZPxvpE5CXme8EoX6JYFSYPDIivr29K72uXpSkdu8kOfU0xE2VS58yd3cg85YO7/v3bCSTg5c5BtoIvoyphnUAtrTwQA8u3DTjKe5CQNeBPNRJx563SO2gTUKxDLX1Jr2mK4cuY4HvcJWDxJSiLBWTeBkz+UBAFA4XZRkpdbJTxVRLzNy070aCl4ggTrPKnWNqG5ENLyzVfWXS10Q4d1/phOuXfecI5bmWovHjukdASCaJaGqoQulyQdIwySI+zdNzBtBcPuAp7HPQJtiLwIL+s1Uh9EukaILgzzIjWVxa7YzCQe9OdIj/h6bfUj4EKt0Pj+m6UKAuKamN3tiaGK18xnl0kHp8+EpSL7ySZTabcydo4T55jeP/6/G8uhotWNpAb7cmM/8VcdHJ7/OHTupIkKwkUm9j01ljBcUbAMY1ois4e1M6S5GRY02ykw2+2als+fglo2bm0PEqr5Ib7QhYqlOM1mXArK3c5J2Nxb577iboV/zo97xAbzKXZWUdZBd7Rck9WOx/ndj2elvni82K5IKAMLMnYpfvo0n7B/K7muLRvl5C/PDRXQ+7JvYJm4OEN3t28G9BPw4Bmxuu2bX8BTdn/sg==
api: eJzdU0tr3DAQ/itiTgko62yPphQCyaG00JBuT4sps/bsWsSWHGm06dbov5exvYmzSQq99uKH9I0032N6qCiU3nRsnIUcVrUJyrvIpLBp3GNQBxcVO1VRQ7JolfM7tOY3SoUKVHrixceNzz4Nj5VTDaG3qnWeFG5c5AkUVIsWd9SSZWWsunWetSprKu+VoLgmta5cGQUwnF6c1cxdyLOscmVY7Ig753lhXBaCu/AbLDNZuJjOP1+ABsZdgHwN32ZdQqGhQ48tMXnZ7SGUNbUIeQ986AhyCOyN3UHSYESHDrkGDRbbYXO44Ofwp8HTQzSeKsjZR9KvFCQlQOW2A6WxdpDxES0/azmKBqnQcn70hg9DaxtCT144jLh8ogeFQD2FztlAQXr/cHkpr5cNXNMWY8PqbkJCShpa4tpVkE9ngh4Z5pDtl9nc0Wy6LetnpBNIj35/VC/6BnI4moOdmXkDSb8FiOEFZkb6u1gx8jlSf3IFO/OFDs9GXEWunT/aOnlVE1bkB5rGbt1QbrgRvGRMXd1+Bg3S/CjQcnEpPncucItW4NPp13/LOJwY3UPpLJPl/2JqRrmZfnHWNWisCDSY2E9BWcN+CRrmNIZQjNHUkM9npNBQu8BS1fcbDPTDNynJ8kMkLzEvNOzRG9yITeseKhPku4J8i004Haq51md30/idq38dtXd4HrNmJWh7bKL8gYZ7OpzMfirmo3R98/VmdQMaMIpC89DeD6GdPoTfm3ecpnm8UJ4yQ2+W9P04Eik94cetdyum6TiihXKRUvoD5pgSPg==
sidebar_class_name: "delete api-method"
info_path: api-reference/port-api
info_path: api-reference-temp/port-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand All @@ -34,7 +33,7 @@ import TabItem from "@theme/TabItem";

<MethodEndpoint
method={"delete"}
path={"/v1/organization/secrets"}
path={"/v1/organization/secrets/{secret_name}"}
>

</MethodEndpoint>
Expand Down
5 changes: 2 additions & 3 deletions docs/api-reference/get-all-organization-secrets.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: "This route allows you to retrieve all of the secrets in your organ
sidebar_label: "Get all organization secrets"
hide_title: true
hide_table_of_contents: true
api: eJzdU8tu2zAQ/BWCpxZQJLtHIwgQoEVQ9NCgdU+GDpS8tohIpLpcqnUF/Xt39UhkwP2BXmRpOTucnR33+gihRNuS9U7v9L6yQaGPBMrUtf8V1MVHRV4hEFroxrLyJ0UVqAAll4OyTlCoPJ6Ns3+McKX3BWYP42PvVQ0GnWo8cn/B7K+tjXHmDA04EpZnj5SosoLyRQlKLjkcfRkFMNLm7yqiNuyyjMshPQO13JNan4Xg77AwZSaFu5n/faoTTeYc9O6gv67k6TzRjIlo6cJnvS5YIaDAEMxxV9QRWrSOgs4HxiKE1rsATNTrD5uN/Fw79xFOJtakvs1IPQyJboAqf+RTFspKWkMVf2TdNlt7lc1qtWjCDjCMkiLWDF7mNa1djauH5BYghivMasjv7GozyV9G7TVdWmAG7vwCF77dmUa+HyOrxsWpRFuZr2JbuEumsu7kx3ZLteBlberx+TNDRfzkxzbdsEjd+kC8ZIHP7E9AU4hWDqg3B65c7XXpHfHy/9doTgsg+E1ZWxs2mi0b19rPYTnobsvAtf4xJpNdvOCKDRZY3xcmwA+sh0HKPyOgJJtfO4PWFLKpQ77O5NOnPVOZKNess/AyZmF+kSAuR07qneG/xo2QjODxKdG82XLPGVGctIdX+HTyz4Y5cwta7MmHYfgL10Oiig==
api: eJzdkk2P1DAMhv9K5BNI2ekMxwohrQRaIQ6sYDiNekhbzzTaNimOUxiq/HfkfiwdafcPcOmH89qxXz8j1Bgqsj1b7yCHY2ODIh8ZlWlb/yuoq4+KvSJksjhMYeXPihtUAStCDso6UZHydDHO/jFSa/e+pOzD9Dh61aIhpzpPqEzpIz+ndsaZC3boWKo8emKtqgarJyUqueRU+yqKYCpbvGmY+5BnWe2rsLsg9554Z30Wgr+j0lSZBO6W+m93oIHNJUB+gq+b9qDQELCKZPkK+WmEEg0hiYzQ1PmSD0UqNBCG3ruAAfIR3u338rq17SOeTWxZfVuUkJKGDrnxNeRwQQYNveEGcsiGQ7Y1KluvkoZoQApTP5FayGEd1vR2Mysk/ZIghhvNZsLvVYPd3P465wh87RFyML39glfQ4Ewn//eRG0+rTRqszNegqZGmqaw7+yndcit62Zm6f/wMGqT52Y/Dbg9JQ+8Dd8aJfKn+gDwTtHFA/XPgxtURKu8YHf+vXM4LYPzNWd8a68Syaa3jAssJhgNo2PY/YbKwqaHxgUU2jqUJ+IPalCT8MyIJ1oWGwZA1pWzqVGyZfPh0BA0myjVbFp4mFpYPAXE9chIfTBtfgmQST09B88WUcZxJS+lZPx+9mrFAt6rFnyKl9BfwTKLx
sidebar_class_name: "get api-method"
info_path: api-reference/port-api
info_path: api-reference-temp/port-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand Down
68 changes: 68 additions & 0 deletions docs/api-reference/get-an-organization-secret.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
id: get-an-organization-secret
title: "Get an organization secret"
description: "This route allows you to retrieve a specific secret in your organization.<br/><br/>To learn more about secrets management in Port, check out the [documentation](https://docs.getport.io/sso-rbac/port-secrets)."
sidebar_label: "Get an organization secret"
hide_title: true
hide_table_of_contents: true
api: eJzdksGK2zAQhl9FzKkFbZz0aEphoWUpPXRp01MwZWJPYrG25I7GblOjdy9jO8WB9AV6kY30z2j+X98IFcWSXScueMhhX7toOPRCBpsm/IzmEnojwTAJOxrIoIkdle7kShOpZBLjvIrYBD6jd79RW23eHjl7Ny37YBpC9qYNTAaPoZelMpoWPZ6pJT91eQ4s1pQ1lS9GVVKTOVSh7FUwtS1e1SJdzLOsCmXcnEm6wLJxIYsxPPARy0w3Hpb+rzdgQfAcIT/A59V4UFiIVPbs5AL5YYQjIROrjAmrfKmHIhUWmGIXfKQI+Qhvtlv93Kb2nk7YN2K+LEpIyUJLUocKcjiTgIUOpYYcsmGXrYPKlquycf757rGlBDoeD8Rxmq7nBnK4WsfOrZxDsvcEfbzRrPx+LWtqZzNX1yPIpSPIATv3iS5gQaeAHB57qQNfQ7Pg1G1NWBFPHp0/hancSaN6fUHz+PwRLOjwczq7zRaShS5EadGrfOn+RGLQ33CzkAH2NuERyuCFvPyniM7pC/2SrGvQec1retNx4eYAww4srOefGJkxtZCv6FG46xBFq8bxiJG+cZOSbv/oiRX4wsKA7PCor3Yo1rQ+fdiDBez11jUXLxMXy49CeT3yuj9g098DZhJPq2J6t2QcZ+pS+qufj/5ZsQB4VWtcRUrpD66ZrHs=
sidebar_class_name: "get api-method"
info_path: api-reference-temp/port-api
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get an organization secret"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/v1/organization/secrets/{secret_name}"}
>

</MethodEndpoint>



This route allows you to retrieve a specific secret in your organization.<br/><br/>To learn more about secrets management in Port, check out the [documentation](https://docs.getport.io/sso-rbac/port-secrets).

<div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>


Default Response


</div><div>

</div>
</TabItem>
</ApiTabs>
</div>
</div>

Loading

0 comments on commit b5a3c72

Please sign in to comment.