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.
- Summary
- Apply transactions to create a new repository URI or edit an existing one.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Transaction Summary
Transaction Summary
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. |
repository
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. |
uri
uri
Change the repository URI.
| Key | Type | Description |
|---|---|---|
| type | const | uri |
| value | string | New repository URI. |
io
io
Adjust I/O behavior.
| Key | Type | Description |
|---|---|---|
| type | const | io |
| value | string | New I/O behavior. |
display
display
Change display behavior.
| Key | Type | Description |
|---|---|---|
| type | const | display |
| value | string | New display behavior. |
credential
credential
Change the credential for this URI.
| Key | Type | Description |
|---|---|---|
| type | const | credential |
| value | phid | New credential PHID, or null. |
disable
disable
Disable or activate the URI.
| Key | Type | Description |
|---|---|---|
| type | const | disable |
| value | bool | True to disable the URI. |
mfa
mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool | True to sign this transaction group with MFA. |
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://phorge.mtrnord.blog/ --conduit-token <conduit-token> -- diffusion.uri.edit
$ curl https://phorge.mtrnord.blog/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/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://phorge.mtrnord.blog/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('diffusion.uri.edit', $api_parameters);
print_r($result);