|
| 1 | +.. _mcli-atlas-integration-delete-cmd: |
| 2 | + |
| 3 | +================================== |
| 4 | +mongocli atlas integrations delete |
| 5 | +================================== |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +.. contents:: On this page |
| 10 | + :local: |
| 11 | + :backlinks: none |
| 12 | + :depth: 1 |
| 13 | + :class: singlecol |
| 14 | + |
| 15 | +The ``integrations delete`` command deletes the specified third-party |
| 16 | +service integration for the |service| project. The command prompts you |
| 17 | +to confirm the operation when you run the command without the ``--force`` option. You can also delete a third-party service integration through |
| 18 | +the |service| :atlas:`API |
| 19 | +</reference/api/third-party-integration-settings-delete/>`. |
| 20 | + |
| 21 | +.. important:: |
| 22 | + |
| 23 | + Deleting an integration from a project removes that integration |
| 24 | + configuration only for that project. This does not affect any other |
| 25 | + project or organization’s configured integrations. |
| 26 | + |
| 27 | +.. _mcli-atlas-integration-delete-syntax: |
| 28 | + |
| 29 | +Syntax |
| 30 | +------ |
| 31 | + |
| 32 | +.. code-block:: sh |
| 33 | + |
| 34 | + mongocli atlas integrations delete|rm <third-party-service> |
| 35 | + [ --force ] |
| 36 | + [ --profile|-P <profile-name> ] |
| 37 | + [ --projectId <id-of-project> ] |
| 38 | + |
| 39 | +.. include:: /includes/fact-command-line-help.rst |
| 40 | + |
| 41 | +.. _mcli-atlas-integration-delete-args: |
| 42 | + |
| 43 | +Arguments |
| 44 | +--------- |
| 45 | + |
| 46 | +.. list-table:: |
| 47 | + :header-rows: 1 |
| 48 | + :widths: 20 10 60 10 |
| 49 | + |
| 50 | + * - Argument |
| 51 | + - Type |
| 52 | + - Description |
| 53 | + - Required? |
| 54 | + |
| 55 | + * - ``<third-party-service>`` |
| 56 | + - string |
| 57 | + - Name of the third-party service integration to delete. |
| 58 | + Valid values are: |
| 59 | + |
| 60 | + - ``DATADOG`` |
| 61 | + - ``FLOWDOCK`` |
| 62 | + - ``NEW_RELIC`` |
| 63 | + - ``OPS_GENIE`` |
| 64 | + - ``PAGER_DUTY`` |
| 65 | + - ``SLACK`` |
| 66 | + - ``VICTOR_OPS`` |
| 67 | + - ``WEBHOOK`` |
| 68 | + |
| 69 | + - yes |
| 70 | + |
| 71 | +.. _mcli-atlas-integration-delete-options: |
| 72 | + |
| 73 | +Options |
| 74 | +------- |
| 75 | + |
| 76 | +.. list-table:: |
| 77 | + :header-rows: 1 |
| 78 | + :widths: 20 10 60 10 |
| 79 | + |
| 80 | + * - Option |
| 81 | + - Type |
| 82 | + - Description |
| 83 | + - Required? |
| 84 | + |
| 85 | + * - ``--force`` |
| 86 | + - |
| 87 | + - Bypasses the confirmation prompt. |
| 88 | + - no |
| 89 | + |
| 90 | + * - ``--profile``, ``-P`` |
| 91 | + - string |
| 92 | + - Name of the profile where the public and private |
| 93 | + keys for the project are saved. If omitted, uses the |
| 94 | + {+default-profile+}. To learn more about creating a |
| 95 | + profile, see :ref:`mcli-configure`. |
| 96 | + - no |
| 97 | + |
| 98 | + * - ``--projectId`` |
| 99 | + - string |
| 100 | + - Unique identifier of the project. If omitted, uses |
| 101 | + the project ID in the profile or :ref:`environment |
| 102 | + variable <mcli-env-var>`. |
| 103 | + - no |
| 104 | + |
| 105 | +.. _mcli-atlas-integration-delete-output: |
| 106 | + |
| 107 | +Output |
| 108 | +------ |
| 109 | + |
| 110 | +The command prints the following to the terminal if the command succeeds. |
| 111 | +If the command prints an error, see :ref:`Troubleshooting |
| 112 | +<mcli-troubleshooting>` for recommended solutions. |
| 113 | + |
| 114 | +.. code-block:: sh |
| 115 | + :copyable: false |
| 116 | + |
| 117 | + Integration '<third-party-service>' deleted |
| 118 | + |
| 119 | +.. _mcli-atlas-integration-delete-egs: |
| 120 | + |
| 121 | +Example |
| 122 | +------- |
| 123 | + |
| 124 | +The following command uses the ``mongocli atlas integrations delete`` |
| 125 | +command to delete ``FLOWDOCK`` integrations with the |service| project. |
| 126 | +It uses the default profile to access |service|. |
| 127 | + |
| 128 | +.. code-block:: sh |
| 129 | + |
| 130 | + mongocli atlas integrations delete FLOWDOCK |
| 131 | + Are you sure you want to delete: FLOWDOCK Yes |
| 132 | + |
| 133 | +The previous command prints the following to the terminal. |
| 134 | + |
| 135 | +.. code-block:: sh |
| 136 | + :copyable: false |
| 137 | + |
| 138 | + Integration 'FLOWDOCK' deleted |
0 commit comments