Skip to content

update the apiSpec with the audit-logs update #2994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update the apiSpec with the audit-logs update #2994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/api-reference/get-audit-logs.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: get-audit-logs
title: "Get audit logs"
description: "This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via [Port's UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will perform a logical `AND` between all query parameters below, and return all logs that match the criteria.<br/><br/>:::warning Beta integration value<br/>The `integration` value in the `resources` parameter is **experimental**. Its behavior may change in future versions of the API.<br/>:::"
description: "This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via [Port's UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will perform a logical `AND` between all query parameters below, and return all logs that match the criteria.<br/><br/>:::warning Beta integration value<br/>The `integration` value in the `resources` parameter is **experimental**. Its behavior may change in future versions of the API.<br/>:::<br/><br/>**Note:** Non-admin users have limited access to the audit logs API. They may:<br/>- Pass an `identifier` to access a specific audit log.<br/>- Pass an `entity` to retrieve audit logs of entities they have access to.<br/>Non-admin users **cannot** view audit logs of deleted entities."
sidebar_label: "Get audit logs"
hide_title: true
hide_table_of_contents: true
api: eJztWW2PGjcQ/ivWfmmLODguF6lCVSWaIxFq1Jxydx9ahIrZ9YKb3fXG9kII4r93xt4XA8ce4QiJqn45dr32+JnxzDPjuZWn6VR53aHXywKuvVHTC5jyJU81F4nX9e5nXBEpMs0IjSKxUGQpMqIFCZn2Z4TiKhKJqSKhFDF+lORWSE2o74ss0S3yJw4583yagCglyISROWcLFsAPJUNc9YMiD4PRjzOtU9Vtt2matqZMp/ClxUVbMa15MlVtg/WtmP7U+mUi27+aPw7QBY8ikjIZChkTirtyn0Zk3PvjZgy76gVjCCEiHzMmlySlksZMM6ngI6jYJDQJiGQ6k3aaga1nVJOYotJ6xgiYCFZw6iDodrsLKhNASH5jmhKeaDaVFA1J5jTKWI6TkbHzaWy/wWwjdyyZAoP5TI0rYARUazTYJ9CJxyzRNGo0WmSgEfCMzrmQgGxJ/BlNpkZSmAF4MC/oBFsoIkIjvHc7aBVQvaZXKQ4OsPKUP2Mx9borTy9TBmevtARlvHXT4+gKxlqwLIFF8MoDQMJDziSMSfYx45IFXjeEs2XbXtRLSDW9QANmJWwOo8alFhQeCr9qwaZfDAjl6+XTYF5bz4WDdbxSsohqcEVAgNhUynwEGxAr9ShAEzjXFCboU2MqBR8FS2bJ3zw4NSbqG0cH4UeBWrDJTIgPg5PjygU/B1QfnfSrIbMxsAcflZIiICCbWD2Cew9wIfkUxh8BrPQywhnIjfAdOCUSAQxomR2mji9iZDjD9pv62E3bqkUsF7MQKTVX22G8dk6moMJ0yiSaxrJBi7wGJhPAcmaeKjg8zxBlgmiaBXY7S/aQSsYPg/FRhzxIFBBqZLY8/SE7em+jo8nyXWiYd99hsySLMTe7RFKxXIYHnDsRPClfSOZTiSrYYERR1fbeaI37b9qkefI9RvtYp8hrX8Ur99q/2Jag3uCbJv01GrdCKT6JmE2+qtHokuG4NMG4ScbWBvgERsCf3Ar4WJoBX6wd8MnN6qMD47kwf2lNX4CUT3gKAQ9DnLqZZ6069ygO7UZ1hhbNYwmPJQCjgCga3VBNYSBmStEpM8f/eCJP/CgLnn8wWNkAzChQGwk9F18UOKBBCrHNoH4JSaZY0CQiiZZbx5bLKYI7lxHsCKkN+KaBTTWMBOAdFxqKp30sgHz2dOyjimBziWUoQXHwEqdFQeP4405F0yygD+7eEQuLjK8ur64uLq8vrl7cd37uXr3sXr9ovex0/nqCyL5ELy0O04olwTfVaQ/8MiyOIeUF17PHqxTcm1yQ8av3/d59H2P34fbGPkEGGt/03/bh5alTKGL37uHVq/7dHYy87g3ePrzve/tIsIzXE6lj5e3BCegmQAl7oEQ85gcUpugbMf3E4ywmViB6hr0RHVSsV2aimRYxzc9TsSi8UEzOuc/2msueVs51W0DXIxTiZxIzFSbRCaMS1IWNJKNB1xjuAoBiTjLEaRjDkO71ZQd/NjW9YSHNIk3e5zMLLoaMiMk6TSO4RZr65R+FC1yVU4lVi+ZWPKRK+AuLlS7AghWkFPJRvy8I+tHqrtJ66JkUbOWMXKK/dXa3261x6fXl9a6WvSojlv4E6OfcsGt1R1tQRRKhIayzJPiuTeFkuFqj7NxJj7LE2toWrs0zAUi8KdPmJq1n8NKed9qV36F/ynlxu85kBDOqzgZv5W0NEz27XyGsywmOq9+hoa1tC4eviouU/86c8OllAFLyz7Qs1HAPCA5kBRNyoTDLuTZJ3vRtercDmJp3DmCw07rEk0mF0jE1Z51Lf8O0w07elnlXlcf830P6D/eQctfDkrWdRhRcDJzFePMqj4qhN+9gXVrxcdObCeSDobdaTahiDzJar3HY0j9GS8AVhfJ8T1ZynevLW0t7QH+A0NnqahmrwqAJ0cMhHddgqoVV3sjOAsnpL9Wicu+MZwHmNplqkZU9rrPAKntMtZjcFtc5YRUNpkPAVa2uUyL8vntGtXYpO2lnObGNblEtrp2u1VnwfbtuSn20O72lI+3wTZoX9Zmoass8Q6fzdCtqFclbK89Q4hzNiVoVTBfllBH2/NZELd6ybfKVMRf9h1owZdPjGR7wZAuiFkHR66gH4Jou7zlUC0b4ArX6BG9KQ2xY5BcprFbtyp7vs9TdZueijFLKm+Ob/r0pi7FGdq9wH8wVLn9w/zuQuPXf9t3OQsC/TpN/c8lqZS+IUGsX8+2nvStyFStGAg3g+vsvT3AcsA==
api: eJztWVtv2zYU/iuEXrYZviRpCgzGMMBr3MJY0RpN8rAFxkRLlM1VEjWSsusZ/u87h9SFdmIldVy3wPoSSxR5+J37JWtP05ny+nfeIA+59iZtL2QqkDzTXKRe37uZc0WkyDUjNI7FUpGVyIkWJGI6mBOKp0gsZopEUiT4UZKxkJrQIBB5qrvkD1xy9gU0BVJKkCkjC86WLIQfSu7w1A+K3I4mP861zlS/16NZ1p0xncGXLhc9xbTm6Uz1DNa3YvZT95ep7P1q/jhAlzyOScZkJGRCKN7KAxoTf/Duyodb9ZIxhBCTf3ImVySjkiZMM6ngI7DYJjQNiWQ6l3abga3nVJOEItN6zgiICE5w6iDo9/tLKlNASH5jmhKeajaTFAVJFjTOWYGTEd/55NtvsNvQ9SVTILCAKb8GRoC1Vot9Ap54wlJN41arS0YaAc/pggsJyFYkmNN0ZihFOYAH8QJPcIUiIjLEB+NRt4Ra42613gnN+q0WeSfSDg0TIJArFAfQZiTmCbAaokKZUqh6JOUoFKkSYGuFICzdDhlT2Aua9nkIgHnEmfTxbEGFEpWxAJaDmlJ39yge1CtzDLQhOVts3QtMmR2coXbgegO3gmnJ7bLUaoH9pUIDt2h8O/RCFjPktaTb9dpebR7gJmtPBXOWUK+/9vQqY+AhCpClM2/T9jg6jLEpOJbCIXit2Yc1yf7JuWSh14/AA9iurw1SUm8vdQbQCDCeauN4SwoPpfd14dLPBmSF+jiY19a/wfwdEUkWU5RPYQSFDkuBrQ4CNAXrz2CDPjamivBBsGSe/sXDY2OigQkHQPwgUEs2nQvxcXR0XAXh54AaopF+MWTWB/bgo1JSBARxKlEP4N4DXEg+g/UHACu9inEHZhD4DpE3FiEsaJk/jZ1AJJgHTE7c5sde2lMYMjFjsQjDUsG2kxd6RcoBFmYzJlE0Nhp0yWuI9wJygdmnykxX5NEqjbbNAXudTYmQcP3bkX+QkkepgrQTmyuPr2SH7110NF29j0zk3adsluYJVjBuIKmjXI4KLowInlQgJAuoRBasMyKp+npvssH7t2XSPvodk31Rp8z+X8Qq98q/vJYg32CbRV0wFkrxacxsiaJarT658ysR+O0qRcMTCAF/CingYyUGfLFywCe39pk80Z9L8VfSDARQ+YRaCHkU4dbtPGvZuUFyKDeqc5Ro4UuolhCEAqRofEU1hYUEigY6Y0b9DyfyNIjz8PmKwfoPYMah2kroBfmyDAQOMvBtBlVehJVL2CYijVc7aivolM5d0AjvEWl0+LaBTTWshGAdHQ0l5r4ogPHscd9HFkHmEot1guTgJcnKgsaxx3sVTbuEPrp+Tyws4l+cXVx0zi47Fy9uzn/uX7zsX77ovjw///ORQPY5fGnxNK5YGn5VnvbAr9zikKC85Hr+cJWCd5MO8V99GA5uhui7t+Mr+wQZyL8avh3Cy2NaKH33+vbVq+H1Nay8Hoze3n4YevuCYOWvR2LH0tuDE9BNISTsgWKan6fZRkI/8SRPiCWIlmH7xicV67WYaK5FQgt9KhZHHehbFjxge8VltVXEuh2gmwkSCXKJmQqT6JRRCezCRZLRsG8E1wGgmJNM4DQRwwTdy7Nz/Nnm9IpFNI81+VDsLGMxZERM1lkWQ69t6pe/FR5wWc4kVi3YV+EbpEr4C4eVLsGCFKQU8kG7LwP0g9VdzfWdZ1KwpTNxA/3Yud1et8Gjl2eX97kc1BmxsidAv+AmutY92pIqAs0kuHWeht+0KJwM1yiUez3pQZLYWNlC2zwXgMSbMW06aT2Hl97ivFfbHdqnXJTddS5j2FHPf3i3GP4Y77n/Fdy62uCY+jUK2sq2NPi6uMj478xxn0EOICX/l1aFGt4BzoFRwbhcJMxxrk2SN9OtwXgEW4v5Ciyed89QM5lQOqFG1wX1N0w70cnbEe+6tpjvk7bvk7b/+aStcFAs7HtZTMERwaWMz6+L2HHnLc6xeq+zVtubC4yad956PaWK3cp4s8FlmyQxpoRcUWhi9uRu1wU/fwC3B/RHCDA7sz9je7BoAtnTIR02hmuEVfWtJ4HkTOEaUbmd9UmAuaO4RmTVJPAksKpJXCMmdxB4SljlGO4p4OqB4DERftuTtUa5VPPGk2hsa6bWiOvebO8k+L7ezKnZ250J3IFy+CojnuZMVA+vnsHTaWY6jYwUA6hnMHGKEU4jC2bWdEwPe/4ApxFvNVz6wpjLKU0jmGo09AwLeHRQ04ignAg1A3BFV0xm6gMTfIGOZor95B2OdYp2E6tVe3IAtXXmXnNvnIBUqv76zfDGlMVYI7uN7kfT6BYP7v9QUrf+2+2ALQT86/wrZPvIem3baKi1y/32094TBYt1RAIONpvNfzy/6YQ=
sidebar_class_name: "get api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down Expand Up @@ -36,12 +36,18 @@ import Heading from "@theme/Heading";



This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via [Port's UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will perform a logical `AND` between all query parameters below, and return all logs that match the criteria.<br/><br/>
This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via [Port's UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will perform a logical `AND` between all query parameters below, and return all logs that match the criteria.

**Note:** Non-admin users have limited access to the audit logs API. They may:<br/>
- Pass an `identifier` to access a specific audit log.
- Pass an `entity` to retrieve audit logs of entities they have access to.

Non-admin users **cannot** view audit logs of deleted entities.

:::warning Beta integration value
The `integration` value in the `resources` parameter is **experimental**. Its behavior may change in future versions of the API.
:::


<Heading
id={"request"}
as={"h2"}
Expand Down
9 changes: 1 addition & 8 deletions static/apispec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28212,14 +28212,7 @@ paths:
summary: Get audit logs
tags:
- Audit
description: "This route allows you to fetch audit logs from your Port account.
Your audit logs can also be viewed via [Port's
UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will
perform a logical `AND` between all query parameters below, and return
all logs that match the criteria.<br/><br/>:::warning Beta integration
value<br/>The `integration` value in the `resources` parameter is
**experimental**. Its behavior may change in future versions of the
API.<br/>:::"
description: "This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via [Port's UI](https://app.getport.io/settings/AuditLog).<br/><br/>This route will perform a logical `AND` between all query parameters below, and return all logs that match the criteria.<br/><br/>**Note:** Non-admin users have limited access to the audit logs API. They may:<br/>- Pass an `identifier` to access a specific audit log.<br/>- Pass an `entity` to retrieve audit logs of entities they have access to.<br/>Non-admin users **cannot** view audit logs of deleted entities.<br/><br/>:::warning Beta integration value<br/>The `integration` value in the `resources` parameter is **experimental**. Its behavior may change in future versions of the API.<br/>:::"
parameters:
- schema:
type: string
Expand Down