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.
- Overview
- Documentation
- Transaction Summary
- space
- vcs
- name
- callsign
- shortName
- description
- encoding
- allowDangerousChanges
- allowEnormousChanges
- status
- defaultBranch
- fetchRefs
- permanentRefs
- trackOnly
- importOnly
- stagingAreaURI
- automationBlueprintPHIDs
- symbolLanguages
- symbolRepositoryPHIDs
- publish
- filesizeLimit
- copyTimeLimit
- touchLimit
- view
- edit
- policy.push
- projects.add
- projects.remove
- projects.set
- mfa
- Call Method
- Examples
diffusion.repository.edit
API Method: diffusion.repository.edit
- Summary
- Apply transactions to create a new repository 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
Transaction Summary
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
Key | Description |
---|---|
space | Shift the object between spaces. |
vcs | Choose which version control system to use when creating a repository. |
name | Rename the repository. |
callsign | Change the repository callsign. |
shortName | Change the repository short name. |
description | Change the repository description. |
encoding | Change the default text encoding. |
allowDangerousChanges | Allow or prevent dangerous changes. |
allowEnormousChanges | Allow or prevent enormous changes. |
status | Active or deactivate the repository. |
defaultBranch | Set the default branch name. |
fetchRefs | Set the fetched refs. |
permanentRefs | Set the permanent refs. |
trackOnly | Set the tracked branches. |
importOnly | Set the subpath to import. |
stagingAreaURI | Set the staging area URI. |
automationBlueprintPHIDs | Change automation blueprints. |
symbolLanguages | Change symbol languages for this repository. |
symbolRepositoryPHIDs | Change symbol source repositories. |
publish | Change publishing options. |
filesizeLimit | Change the filesize limit. |
copyTimeLimit | Change the copy time limit. |
touchLimit | Change the touch limit. |
view | Change the view policy of the object. |
edit | Change the edit policy of the object. |
policy.push | Change the push policy of the repository. |
projects.add | Add project tags. |
projects.remove | Remove project tags. |
projects.set | Set project tags, overwriting current value. |
mfa | Sign this transaction group with MFA. |
space
Shift the object between spaces.
Key | Type | Description |
---|---|---|
type | const | space |
value | phid | New space PHID. |
vcs
Choose which version control system to use when creating a repository.
Key | Type | Description |
---|---|---|
type | const | vcs |
value | string | Version control system selection. |
name
Rename the repository.
Key | Type | Description |
---|---|---|
type | const | name |
value | string | New repository name. |
callsign
Change the repository callsign.
Key | Type | Description |
---|---|---|
type | const | callsign |
value | string | New repository callsign. |
shortName
Change the repository short name.
Key | Type | Description |
---|---|---|
type | const | shortName |
value | string | New short name for the repository. |
description
Change the repository description.
Key | Type | Description |
---|---|---|
type | const | description |
value | string | New repository description. |
encoding
Change the default text encoding.
Key | Type | Description |
---|---|---|
type | const | encoding |
value | string | New text encoding. |
allowDangerousChanges
Allow or prevent dangerous changes.
Key | Type | Description |
---|---|---|
type | const | allowDangerousChanges |
value | bool | New protection setting. |
allowEnormousChanges
Allow or prevent enormous changes.
Key | Type | Description |
---|---|---|
type | const | allowEnormousChanges |
value | bool | New protection setting. |
status
Active or deactivate the repository.
Key | Type | Description |
---|---|---|
type | const | status |
value | string | New repository status. |
defaultBranch
Set the default branch name.
Key | Type | Description |
---|---|---|
type | const | defaultBranch |
value | string | New default branch name. |
fetchRefs
Set the fetched refs.
Key | Type | Description |
---|---|---|
type | const | fetchRefs |
value | list<string> | New fetched refs. |
permanentRefs
Set the permanent refs.
Key | Type | Description |
---|---|---|
type | const | permanentRefs |
value | list<string> | New permanent ref rules. |
trackOnly
Set the tracked branches.
Key | Type | Description |
---|---|---|
type | const | trackOnly |
value | list<string> | New tracked branches. |
importOnly
Set the subpath to import.
Key | Type | Description |
---|---|---|
type | const | importOnly |
value | string | New subpath to import. |
stagingAreaURI
Set the staging area URI.
Key | Type | Description |
---|---|---|
type | const | stagingAreaURI |
value | string | New staging area URI. |
automationBlueprintPHIDs
Change automation blueprints.
Key | Type | Description |
---|---|---|
type | const | automationBlueprintPHIDs |
value | list<phid> | New blueprint PHIDs. |
symbolLanguages
Change symbol languages for this repository.
Key | Type | Description |
---|---|---|
type | const | symbolLanguages |
value | list<string> | New symbol languages. |
symbolRepositoryPHIDs
Change symbol source repositories.
Key | Type | Description |
---|---|---|
type | const | symbolRepositoryPHIDs |
value | list<phid> | New symbol repositories. |
publish
Change publishing options.
Key | Type | Description |
---|---|---|
type | const | publish |
value | bool | New notification setting. |
filesizeLimit
Change the filesize limit.
Key | Type | Description |
---|---|---|
type | const | filesizeLimit |
value | string | New repository filesize limit. |
copyTimeLimit
Change the copy time limit.
Key | Type | Description |
---|---|---|
type | const | copyTimeLimit |
value | string | New repository copy time limit. |
touchLimit
Change the touch limit.
Key | Type | Description |
---|---|---|
type | const | touchLimit |
value | string | New repository touch limit. |
view
Change the view policy of the object.
Key | Type | Description |
---|---|---|
type | const | view |
value | string | New policy PHID or constant. |
edit
Change the edit policy of the object.
Key | Type | Description |
---|---|---|
type | const | edit |
value | string | New policy PHID or constant. |
policy.push
Change the push policy of the repository.
Key | Type | Description |
---|---|---|
type | const | policy.push |
value | string | New policy PHID or constant. |
projects.add
Add project tags.
Key | Type | Description |
---|---|---|
type | const | projects.add |
value | list<project> | List of PHIDs to add. |
projects.remove
Remove project tags.
Key | Type | Description |
---|---|---|
type | const | projects.remove |
value | list<project> | List of PHIDs to remove. |
projects.set
Set project tags, overwriting current value.
Key | Type | Description |
---|---|---|
type | const | projects.set |
value | list<project> | List of PHIDs to set. |
mfa
Sign this transaction group with MFA.
Key | Type | Description |
---|---|---|
type | const | mfa |
value | bool |
Call Method
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.
-d api.token=api-token \
-d param=value \
...