This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit diffusion.uri.edit
diffusion.uri.edit
diffusion.uri.edit
API Method: diffusion.uri.edit
API Method: diffusion.uri.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Description
Transaction Types
Transaction Types
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| repository | Create a URI in a given repository. This transaction type must be present when creating a new URI and must not be present when editing an existing URI. |
| uri | Change the repository URI. |
| io | Adjust I/O behavior. |
| display | Change display behavior. |
| credential | Change the credential for this URI. |
| disable | Disable or activate the URI. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: repository
Transaction Type: repository
Create a URI in a given repository. This transaction type must be present when creating a new URI and must not be present when editing an existing URI.
| Key | Type | Description |
|---|---|---|
| type | const | repository |
| value | phid | Repository PHID to create a new URI for. |
Transaction Type: uri
Transaction Type: uri
Change the repository URI.
| Key | Type | Description |
|---|---|---|
| type | const | uri |
| value | string | New repository URI. |
Transaction Type: io
Transaction Type: io
Adjust I/O behavior.
| Key | Type | Description |
|---|---|---|
| type | const | io |
| value | string | New I/O behavior. |
Transaction Type: display
Transaction Type: display
Change display behavior.
| Key | Type | Description |
|---|---|---|
| type | const | display |
| value | string | New display behavior. |
Transaction Type: credential
Transaction Type: credential
Change the credential for this URI.
| Key | Type | Description |
|---|---|---|
| type | const | credential |
| value | phid | New credential PHID, or null. |
Transaction Type: disable
Transaction Type: disable
Disable or activate the URI.
| Key | Type | Description |
|---|---|---|
| type | const | disable |
| value | bool | True to disable the URI. |
Transaction Type: mfa
Transaction Type: mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://dev.gnupg.org/ --conduit-token <conduit-token> diffusion.uri.edit
$ curl https://dev.gnupg.org/api/diffusion.uri.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/libphutil/src/__phutil_library_init__.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://dev.gnupg.org/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('diffusion.uri.edit', $api_parameters);
print_r($result);